XDR kommit v0.1.0 XDR.VariableOpaque View Source

This module is in charge of process the Variable length opaque based on the RFC4506 XDR Standard

Link to this section Summary

Types

t()

Every double float structure has a float which represent the Double-Precision Floating-Point value which you try to encode

Functions

this function is in charge of decode the XDR into a variable length opaque,it receives an XDR.VariableOpaque stucture which contains the needed data to decode the opaque

this function is in charge of decode the XDR into a variable length opaque,it receives an XDR.VariableOpaque stucture which contains the needed data to decode the opaque

this function is in charge of encode the variable length opaque into an XDR,it receives an XDR.VariableOpaque stucture which contains the needed data to encode the opaque

this function is in charge of encode the variable length opaque into an XDR,it receives an XDR.VariableOpaque stucture which contains the needed data to encode the opaque

this function provides an easy way to create an XDR.VariableOpaque type

Link to this section Types

Specs

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

Every double float structure has a float which represent the Double-Precision Floating-Point value which you try to encode

Link to this section Functions

Link to this function

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

View Source

Specs

decode_xdr(bytes :: binary(), opts :: map()) :: {:ok, {t(), binary()}}

this function is in charge of decode the XDR into a variable length opaque,it receives an XDR.VariableOpaque stucture which contains the needed data to decode the opaque

returns an :ok tuple with the resulted binary

Link to this function

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

View Source

Specs

decode_xdr!(bytes :: binary(), opts :: map()) :: {t(), binary()}

this function is in charge of decode the XDR into a variable length opaque,it receives an XDR.VariableOpaque stucture which contains the needed data to decode the opaque

returns an :ok tuple with the resulted binary

Specs

encode_xdr(map()) :: {:ok, binary()}

this function is in charge of encode the variable length opaque into an XDR,it receives an XDR.VariableOpaque stucture which contains the needed data to encode the opaque

returns an :ok tuple with the resulted XDR

Specs

encode_xdr!(map()) :: binary()

this function is in charge of encode the variable length opaque into an XDR,it receives an XDR.VariableOpaque stucture which contains the needed data to encode the opaque

returns the resulted XDR

Link to this function

new(opaque, max_size \\ 4294967295)

View Source

Specs

new(opaque :: binary() | nil, max_size :: integer()) :: t()

this function provides an easy way to create an XDR.VariableOpaque type

returns a XDR.VariableOpaque struct with the value received as parameter