RustQ.Rustler.Opts (rustq v0.7.0)

Copy Markdown View Source

Generates Rustler keyword/options structs, decoders, and option helper functions.

Summary

Functions

decode_args(arg1)
decode_opts(arg1)
decoder(name, opts)
helpers(opts \\ [])
opt_atom_option(arg1, arg2)
opt_bool_option(arg1, arg2)
opt_f32(arg1, arg2)
opt_f32_default(arg1, arg2, arg3)
opt_f32_option(arg1, arg2)
opt_term(arg1, arg2)

Functions

decode_args(arg1)

@spec decode_args(term()) :: RustQ.Type.nif_result(RustQ.Type.vec(term()))

decode_opts(arg1)

@spec decode_opts(term()) ::
  RustQ.Type.nif_result(RustQ.Type.vec({RustQ.Type.path(:Atom), term()}))

decoder(name, opts)

@spec decoder(
  atom() | String.t(),
  keyword()
) :: [RustQ.Rust.Fragment.t()]

helpers(opts \\ [])

@spec helpers(keyword()) :: [RustQ.Rust.Fragment.t()]

opt_atom_option(arg1, arg2)

@spec opt_atom_option(
  RustQ.Type.slice({RustQ.Type.path(:Atom), term()}),
  RustQ.Type.path(:Atom)
) ::
  RustQ.Type.nif_result(RustQ.Type.option(RustQ.Type.path(:Atom)))

opt_bool_option(arg1, arg2)

@spec opt_bool_option(
  RustQ.Type.slice({RustQ.Type.path(:Atom), term()}),
  RustQ.Type.path(:Atom)
) ::
  RustQ.Type.nif_result(RustQ.Type.option(boolean()))

opt_f32(arg1, arg2)

@spec opt_f32(
  RustQ.Type.slice({RustQ.Type.path(:Atom), term()}),
  RustQ.Type.path(:Atom)
) ::
  RustQ.Type.nif_result(RustQ.Type.f32())

opt_f32_default(arg1, arg2, arg3)

@spec opt_f32_default(
  RustQ.Type.slice({RustQ.Type.path(:Atom), term()}),
  RustQ.Type.path(:Atom),
  RustQ.Type.f32()
) :: RustQ.Type.nif_result(RustQ.Type.f32())

opt_f32_option(arg1, arg2)

@spec opt_f32_option(
  RustQ.Type.slice({RustQ.Type.path(:Atom), term()}),
  RustQ.Type.path(:Atom)
) ::
  RustQ.Type.nif_result(RustQ.Type.option(RustQ.Type.f32()))

opt_term(arg1, arg2)

@spec opt_term(
  RustQ.Type.slice({RustQ.Type.path(:Atom), term()}),
  RustQ.Type.path(:Atom)
) ::
  RustQ.Type.option(term())