XDR.VariableOpaque (Elixir XDR v0.3.11) View Source

This module manages the Variable-Length Opaque Data type based on the RFC4506 XDR Standard.

Link to this section Summary

Types

opaque()

t()

XDR.VariableOpaque structure type specification.

Functions

decode_xdr(bytes, opaque \\ %{max_size: 4294967295})

Decode the Variable-Length Opaque Data in XDR format to a XDR.VariableOpaque structure.

decode_xdr!(bytes, opaque \\ %{max_size: 4294967295})

Decode the Variable-Length Opaque Data in XDR format to a XDR.VariableOpaque structure. If the binaries are not valid, an exception is raised.

encode_xdr(map)

Encode a XDR.VariableOpaque structure into a XDR format.

encode_xdr!(opaque)

Encode a XDR.VariableOpaque structure into a XDR format. If the opaque is not valid, an exception is raised.

new(opaque, max_size \\ 4294967295)

Create a new XDR.VariableOpaque structure with the opaque and max_size passed.

Link to this section Types

opaque()

Specs

opaque() :: binary() | nil

t()

Specs

t() :: %XDR.VariableOpaque{max_size: integer(), opaque: opaque()}

XDR.VariableOpaque structure type specification.

Link to this section Functions

decode_xdr(bytes, opaque \\ %{max_size: 4294967295})

Decode the Variable-Length Opaque Data in XDR format to a XDR.VariableOpaque structure.

decode_xdr!(bytes, opaque \\ %{max_size: 4294967295})

Decode the Variable-Length Opaque Data in XDR format to a XDR.VariableOpaque structure. If the binaries are not valid, an exception is raised.

encode_xdr(map)

Encode a XDR.VariableOpaque structure into a XDR format.

encode_xdr!(opaque)

Encode a XDR.VariableOpaque structure into a XDR format. If the opaque is not valid, an exception is raised.

new(opaque, max_size \\ 4294967295)

Specs

new(opaque :: opaque(), max_size :: integer()) :: t()

Create a new XDR.VariableOpaque structure with the opaque and max_size passed.