XDR kommit v0.1.0 XDR.Void View Source

This module is in charge of manage the Void types based on the RFC4506 XDR Standard

Link to this section Summary

Types

t()

the void type contains the value of the void it must be void or binary

Functions

this function is in charge of decoding the void values into an vo format, it receives an XDR.Void structure which contains the void value

this function is in charge of decoding the void values into an vo format, it receives an XDR.Void structure which contains the void value

this function is in charge of encoding the void values into an XDR format, it receives an XDR.Void structure which contains the void value

this function is in charge of encoding the void values into an XDR format, it receives an XDR.Void structure which contains the void value

this function provides an easy way to create a new void type, it receives the value and create a new XDR.Void structure

Link to this section Types

Specs

t() :: %XDR.Void{void: binary() | nil}

the void type contains the value of the void it must be void or binary

Link to this section Functions

Specs

decode_xdr(binary(), any()) :: {:ok, {nil, binary()}}

this function is in charge of decoding the void values into an vo format, it receives an XDR.Void structure which contains the void value

returns and ok tuple with the resulted void

Specs

decode_xdr!(binary(), any()) :: {nil, binary()}

this function is in charge of decoding the void values into an vo format, it receives an XDR.Void structure which contains the void value

returns the resulted void

Specs

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

this function is in charge of encoding the void values into an XDR format, it receives an XDR.Void structure which contains the void value

returns and ok tuple with the resulted XDR

Specs

encode_xdr!(t()) :: binary()

this function is in charge of encoding the void values into an XDR format, it receives an XDR.Void structure which contains the void value

returns the resulted XDR

Specs

new(nil) :: t()

this function provides an easy way to create a new void type, it receives the value and create a new XDR.Void structure

returns an XDR.Void structure