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

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

Link to this section Summary

Types

t()

XDR.Bool struct type specification.

Functions

Decode the Boolean in XDR format to a XDR.Bool structure.

Decode the Boolean in XDR format to a XDR.Bool structure. If the binary is not a valid boolean, an exception is raised.

Encode a XDR.Bool structure into a XDR format.

Encode a XDR.Bool structure into a XDR format. If the structure received is not XDR.Bool or the identifier is not boolean, an exception is raised.

Create a new XDR.Bool structure from the identifier passed either false or true.

Link to this section Types

Specs

t() :: %XDR.Bool{declarations: keyword(), identifier: boolean()}

XDR.Bool struct type specification.

Link to this section Functions

Link to this function

decode_xdr(bytes, struct \\ %XDR.Bool{})

View Source

Decode the Boolean in XDR format to a XDR.Bool structure.

Link to this function

decode_xdr!(bytes, struct \\ %XDR.Bool{})

View Source

Decode the Boolean in XDR format to a XDR.Bool structure. If the binary is not a valid boolean, an exception is raised.

Encode a XDR.Bool structure into a XDR format.

Encode a XDR.Bool structure into a XDR format. If the structure received is not XDR.Bool or the identifier is not boolean, an exception is raised.

Specs

new(identifier :: atom()) :: t()

Create a new XDR.Bool structure from the identifier passed either false or true.