Elixir XDR v0.3.10

XDR.String (Elixir XDR v0.3.10) View Source

This module manages the String type based on the RFC4506 XDR Standard.

Link to this section Summary

Types

t()

XDR.String structure type specification.

Functions

decode_xdr(bytes, string \\ %{max_length: 4294967295})

Decode the String in XDR format to a XDR.String structure.

decode_xdr!(bytes, string \\ %{max_length: 4294967295})

Decode the String in XDR format to a XDR.String structure. If the binaries are not valid, an exception is raised.

encode_xdr(map)

Encode a XDR.String structure into a XDR format.

encode_xdr!(string)

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

new(string, max_length \\ 4294967295)

Create a new XDR.String structure with the opaque and length passed.

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %XDR.String{max_length: integer(), string: binary()}

XDR.String structure type specification.

Link to this section Functions

Link to this function

decode_xdr(bytes, string \\ %{max_length: 4294967295})

View Source

Decode the String in XDR format to a XDR.String structure.

Link to this function

decode_xdr!(bytes, string \\ %{max_length: 4294967295})

View Source

Decode the String in XDR format to a XDR.String structure. If the binaries are not valid, an exception is raised.

Link to this function

encode_xdr(map)

View Source

Encode a XDR.String structure into a XDR format.

Link to this function

encode_xdr!(string)

View Source

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

Link to this function

new(string, max_length \\ 4294967295)

View Source

Specs

new(string :: bitstring(), max_length :: integer()) :: t()

Create a new XDR.String structure with the opaque and length passed.