Enum TypedTerm 

pub enum TypedTerm<'id> {
    Atom(Atom),
    Bitstring(Bitstring<'id>),
    Float(Float<'id>),
    Fun(Fun<'id>),
    Integer(Integer<'id>),
    List(List<'id>),
    Map(Map<'id>),
    Pid(Pid<'id>),
    Port(Port<'id>),
    Reference(Reference<'id>),
    Tuple(Tuple<'id>),
}

Typed enum produced by AnyTerm::resolve. One enif_term_type call has been made; the data is still on the BEAM heap.

Mirrors BEAM’s ErlNifTermType: byte-aligned binaries and sub-byte bitstrings share the Bitstring variant (BEAM treats every binary as a bitstring). Refine with Bitstring::to_binary.

Variants

Atom(Atom)

An atom.

Bitstring(Bitstring<'id>)

A binary or sub-byte bitstring (enif_term_type reports both as Bitstring). Refine to a byte-aligned Binary with Bitstring::to_binary.

Float(Float<'id>)

A float.

Fun(Fun<'id>)

A fun (closure or &module:function/arity).

Integer(Integer<'id>)

An integer (fixnum or bignum).

List(List<'id>)

A list (proper or improper; the empty list [] is also a list).

Map(Map<'id>)

A map.

Pid(Pid<'id>)

A pid (local or external).

Port(Port<'id>)

A port (local or external).

Reference(Reference<'id>)

A reference.

Tuple(Tuple<'id>)

A tuple.

Trait Implementations

impl<'id> Clone for TypedTerm<'id>

fn clone(&self) -> TypedTerm<'id>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'id> Copy for TypedTerm<'id>

impl<'id> Decoder<'id> for TypedTerm<'id>

Resolves the term to its TypedTerm variant (one enif_term_type call). A type code this otter build does not recognize — a term type from a newer OTP — is UnknownTermType.

fn decode(term: AnyTerm<'id>, env: impl Env<'id>) -> Result<Self, CodecError>

impl<'id> Encoder<'id> for TypedTerm<'id>

Encodes the already-resolved term by rewrapping its word. Never fails.

fn encode(&self, env: impl Env<'id>) -> Result<AnyTerm<'id>, CodecError>

impl Eq for TypedTerm<'_>

impl<'id> From<Atom> for TypedTerm<'id>

fn from(v: Atom) -> Self

Converts to this type from the input type.

impl<'id> From<Binary<'id>> for TypedTerm<'id>

fn from(v: Binary<'id>) -> Self

A binary is a byte-aligned bitstring, so it lands in the Bitstring variant.

impl<'id> From<Bitstring<'id>> for TypedTerm<'id>

fn from(v: Bitstring<'id>) -> Self

Converts to this type from the input type.

impl<'id> From<Float<'id>> for TypedTerm<'id>

fn from(v: Float<'id>) -> Self

Converts to this type from the input type.

impl<'id> From<Fun<'id>> for TypedTerm<'id>

fn from(v: Fun<'id>) -> Self

Converts to this type from the input type.

impl<'id> From<Integer<'id>> for TypedTerm<'id>

fn from(v: Integer<'id>) -> Self

Converts to this type from the input type.

impl<'id> From<List<'id>> for TypedTerm<'id>

fn from(v: List<'id>) -> Self

Converts to this type from the input type.

impl<'id> From<Map<'id>> for TypedTerm<'id>

fn from(v: Map<'id>) -> Self

Converts to this type from the input type.

impl<'id> From<Pid<'id>> for TypedTerm<'id>

fn from(v: Pid<'id>) -> Self

Converts to this type from the input type.

impl<'id> From<Port<'id>> for TypedTerm<'id>

fn from(v: Port<'id>) -> Self

Converts to this type from the input type.

impl<'id> From<Reference<'id>> for TypedTerm<'id>

fn from(v: Reference<'id>) -> Self

Converts to this type from the input type.

impl<'id> From<Tuple<'id>> for TypedTerm<'id>

fn from(v: Tuple<'id>) -> Self

Converts to this type from the input type.

impl Ord for TypedTerm<'_>

Erlang term order (enif_compare) — the standard cross-type ordering number < atom < reference < fun < port < pid < tuple < map < nil < list < bitstring, not a Rust-derived ordering.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TypedTerm<'_>

Term identity (enif_is_identical) — the BEAM’s =:=, not Rust structural equality. Ignores the variant tag and compares the underlying terms.

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TypedTerm<'_>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'id> Term<'id> for TypedTerm<'id>

fn raw_term(self) -> Term

Extract the underlying machine word, discarding the variant tag.

fn copy_to<'dst>(self, env: impl Env<'dst>) -> AnyTerm<'dst>

where Self: Sized,

Copy this term into another environment (enif_make_copy), producing a term branded to the destination. The general cross-env copy — distinct from same-brand Encoder (which wraps for free) and from OwnedEnvArena copy_out (the arena exit).