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

This module manages the Discriminated Union type based on the RFC4506 XDR Standard.

Link to this section Summary

Types

arms()

t()

XDR.Union structure type specification.

Functions

decode_xdr(bytes, union)

Decode the Discriminated Union in XDR format to a XDR.Union structure.

decode_xdr!(bytes, union)

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

encode_xdr(map)

Encode a XDR.Union structure into a XDR format.

encode_xdr!(union)

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

new(discriminant, arms, value \\ nil)

Create a new XDR.Union structure with the discriminant, arms and value passed.

Link to this section Types

arms()

Specs

arms() :: keyword() | map()

discriminant()

Specs

discriminant() :: XDR.Enum.t() | XDR.Int.t() | XDR.UInt.t() | struct()

t()

Specs

t() :: %XDR.Union{arms: arms(), discriminant: discriminant(), value: any()}

XDR.Union structure type specification.

Link to this section Functions

decode_xdr(bytes, union)

Decode the Discriminated Union in XDR format to a XDR.Union structure.

decode_xdr!(bytes, union)

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

encode_xdr(map)

Encode a XDR.Union structure into a XDR format.

encode_xdr!(union)

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

new(discriminant, arms, value \\ nil)

Specs

new(discriminant :: discriminant(), arms :: arms(), value :: any()) :: t()

Create a new XDR.Union structure with the discriminant, arms and value passed.