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

This module manages the Hyper Integer type based on the RFC4506 XDR Standard.

Link to this section Summary

Types

datum()

t()

XDR.HyperInt structure type specification.

Functions

decode_xdr(bytes, h_int \\ nil)

Decode the Hyper Integer in XDR format to a XDR.HyperInt structure.

decode_xdr!(bytes, h_int \\ nil)

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

encode_xdr(hyper_int)

Encode a XDR.HyperInt structure into a XDR format.

encode_xdr!(h_int)

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

Create a new XDR.HyperInt structure with the datum passed.

Link to this section Types

datum()

Specs

datum() :: integer() | binary()

t()

Specs

t() :: %XDR.HyperInt{datum: datum()}

XDR.HyperInt structure type specification.

Link to this section Functions

decode_xdr(bytes, h_int \\ nil)

Decode the Hyper Integer in XDR format to a XDR.HyperInt structure.

decode_xdr!(bytes, h_int \\ nil)

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

encode_xdr(hyper_int)

Encode a XDR.HyperInt structure into a XDR format.

encode_xdr!(h_int)

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

new(datum)

Specs

new(datum :: datum()) :: t()

Create a new XDR.HyperInt structure with the datum passed.