XDR kommit v0.1.0 XDR.Bool View Source

This module is in charge of process the boolean types based on the RFC4056 XDR Standard

Link to this section Summary

Functions

This function is in charge of decode XDR data which represents a boolean value

This function is in charge of decode XDR data which represents a boolean value

This function is in charge of encode the boolean data to a binary representation

This function is in charge of encode the boolean data to a binary representation

Link to this section Types

Specs

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

Link to this section Functions

Link to this function

decode_xdr(bytes, struct \\ %XDR.Bool{declarations: [false: 0, true: 1]})

View Source

Specs

decode_xdr(bytes :: binary(), struct :: t() | any()) :: {:ok, {t(), binary()}}

This function is in charge of decode XDR data which represents a boolean value

returns an ok tuple with the boolean decoded from an XDR value

Link to this function

decode_xdr!(bytes, struct \\ %XDR.Bool{declarations: [false: 0, true: 1]})

View Source

Specs

decode_xdr!(bytes :: binary(), struct :: t() | any()) :: {t(), binary()}

This function is in charge of decode XDR data which represents a boolean value

returns the boolean decoded from an XDR value

Specs

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

This function is in charge of encode the boolean data to a binary representation

returns an ok tuple with the boolean encoded into an XDR value

Specs

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

This function is in charge of encode the boolean data to a binary representation

returns the boolean encoded into an XDR value

Specs

new(atom()) :: t()