Struct Integer 

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

An Erlang integer. Arbitrary precision — small integers are tagged immediates, large integers (bignums) are heap-allocated on the env.

Carries only its env’s brand 'id, not the env itself. An integer can be read back only with an env of the same brand (the 1:1 identity guarantee), so the accessors take the env explicitly rather than the term carrying it.

Implementations

impl<'id> Integer<'id>

pub fn from_raw(raw_term: Term) -> Self

Available on crate feature raw only.

pub fn from_i64(env: impl Env<'id>, val: i64) -> Self

Construct an integer term from an i64 (enif_make_int64).

pub fn from_u64(env: impl Env<'id>, val: u64) -> Self

Construct an integer term from a u64 (enif_make_uint64).

pub fn to_i64(self, env: impl Env<'id>) -> Option<i64>

Read back an i64 (enif_get_int64). None if the term does not fit in i64. env must carry the same brand as this term.

pub fn to_u64(self, env: impl Env<'id>) -> Option<u64>

Read back a u64 (enif_get_uint64). None if the term does not fit in u64 (including negatives).

pub fn to_bigint(self, env: impl Env<'id>) -> BigInt

Available on crate feature bigint only.

Read this integer as an arbitrary-precision BigInt, including bignums that exceed i64/u64 — which to_i64 / to_u64 cannot reach, since the NIF API has no accessor beyond enif_get_int64/enif_get_uint64.

Total over every integer term: it serializes the term to the external term format (enif_term_to_binary) and reconstructs the value from the ETF integer encoding. Infallible — the term is already a validated integer, so it always serializes to one of the four ETF integer tags.

Requires the bigint feature.

pub fn from_bigint(env: impl Env<'id>, val: &BigInt) -> Self

Available on crate feature bigint only.

Construct an integer term from an arbitrary-precision BigInt, including values beyond i64/u64.

Values within range go straight through enif_make_int64 / enif_make_uint64; larger magnitudes are emitted as an ETF bignum (SMALL_BIG_EXT/LARGE_BIG_EXT) and parsed back with enif_binary_to_term. Infallible.

Requires the bigint feature.

Trait Implementations

impl<'id> Clone for Integer<'id>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'id> Copy for Integer<'id>

impl Debug for Integer<'_>

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

Formats the value using the given formatter.

impl<'id> Decoder<'id> for Integer<'id>

Accepts an integer term (enif_term_type == Integer); rejects anything else as WrongType.

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

impl<'id> Encoder<'id> for Integer<'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 Integer<'_>

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

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

Converts to this type from the input type.

impl Ord for Integer<'_>

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

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

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