Struct Binary 

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

A byte-aligned binary (enif_is_binary returned true).

Data is on the BEAM heap. Nothing is copied until as_bytes/from_bytes is called. The byte accessors take an impl Env<'id> (this brand) because the term carries only its brand, not its env.

Implementations

impl<'id> Binary<'id>

pub fn from_raw(raw_term: Term) -> Self

Available on crate feature raw only.

pub fn as_bytes(self, env: impl Env<'id>) -> &'id [u8]

View the binary data as a byte slice (enif_inspect_binary).

Zero-copy — the slice points into the BEAM heap and rides this binary’s brand 'id, which cannot escape its env’s scope.

pub fn len(self, env: impl Env<'id>) -> usize

Number of bytes in the binary.

pub fn is_empty(self, env: impl Env<'id>) -> bool

Returns true if the binary contains no bytes.

pub fn try_str(self, env: impl Env<'id>) -> Result<&'id str, Utf8Error>

Interpret the binary as a UTF-8 string (zero-copy). Err if the bytes are not valid UTF-8.

pub fn sub(self, env: impl Env<'id>, pos: usize, len: usize) -> Binary<'id>

Create a zero-copy sub-binary term spanning pos..pos+len (enif_make_sub_binary). Panics if out of bounds.

pub fn from_bytes(env: impl Env<'id>, data: &[u8]) -> Binary<'id>

Allocate a new binary on the BEAM heap and copy data into it (enif_make_new_binary).

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

Returns true if term is a byte-aligned binary (enif_is_binary). Sub-byte bitstrings return false.

pub fn deserialize(self, env: impl Env<'id>, safe: bool) -> Option<AnyTerm<'id>>

Deserialize a term from this binary’s external-term-format contents (enif_binary_to_term). If safe, encoded atoms not already in the atom table are rejected. None on decode failure.

Trait Implementations

impl<'id> Clone for Binary<'id>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'id> Copy for Binary<'id>

impl Debug for Binary<'_>

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

Formats the value using the given formatter.

impl<'id> Decoder<'id> for Binary<'id>

Accepts a byte-aligned binary (enif_is_binary); a sub-byte bitstring is rejected as WrongType — decode to Bitstring for those.

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

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

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 Ord for Binary<'_>

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

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

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