Struct Tuple 

pub struct Tuple<'id> { /* private fields */ }

An Erlang tuple.

The lean form: a one-word term handle, like every other otter term. Reading its elements is an explicit step — with_elements performs the single enif_get_tuple and yields a TupleView, the collection-like form. Keeping the two separate means a tuple that is only passed through (matched in TypedTerm, re-encoded, compared) never pays for the element fetch.

Implementations

impl<'id> Tuple<'id>

pub fn from_raw(raw_term: Term) -> Self

Available on crate feature raw only.

pub fn with_elements(self, env: impl Env<'id>) -> TupleView<'id>

Resolve the tuple’s elements (one enif_get_tuple) into a TupleView.

A Tuple is only ever built from a term already confirmed to be a tuple, so enif_get_tuple cannot fail — a zero return is an internal contract violation, not a user-input case, hence the assert.

pub fn from_terms<I, T>(env: impl Env<'id>, terms: I) -> Tuple<'id>

where I: IntoIterator<Item = T>, T: Term<'id>,

Construct a tuple from any iterable of terms of this brand (enif_make_tuple_from_array).

pub fn is_tuple(env: impl Env<'id>, term: impl Term<'id>) -> bool

Returns true if term is a tuple (enif_is_tuple).

Trait Implementations

impl<'id> Clone for Tuple<'id>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'id> Copy for Tuple<'id>

impl Debug for Tuple<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'id> Decoder<'id> for Tuple<'id>

Accepts a tuple of any arity (enif_is_tuple); WrongType otherwise.

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

impl<'id> Encoder<'id> for Tuple<'id>

Encodes for free by rewrapping the term’s own machine word — an otter term is already an Erlang term. Never fails.

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

impl Eq for Tuple<'_>

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 Tuple<'_>

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 Tuple<'_>

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 Tuple<'_>

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 Tuple<'id>

fn raw_term(self) -> Term

The raw machine word backing this term.

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).