RustQ.Rustler.Decode (rustq v0.11.1)

Copy Markdown View Source

AST helpers for composing Rustler term decoding expressions.

Summary

Functions

Builds an atom expression used as a decode key.

Builds a fallible options-helper call.

Fetches and decodes an optional term as Option<type>.

Converts an optional expression into NifResult with BadArg when absent.

Builds an options-helper call whose decoded option must be present.

Fetches a required term from decoded options.

Fetches and decodes a required term as type.

Functions

atom(name, opts \\ [])

Builds an atom expression used as a decode key.

opt_decode(helper, opts_var, atom_name, opts \\ [])

Builds a fallible options-helper call.

optional_term_decode(opts_var, atom_name, type, opts \\ [])

Fetches and decodes an optional term as Option<type>.

require_some(expression)

Converts an optional expression into NifResult with BadArg when absent.

required_opt_decode(helper, opts_var, atom_name, opts \\ [])

Builds an options-helper call whose decoded option must be present.

required_term(opts_var, atom_name, opts \\ [])

Fetches a required term from decoded options.

required_term_decode(opts_var, atom_name, type, opts \\ [])

Fetches and decodes a required term as type.