Struct Bitstring 

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

An Erlang bitstring (enif_term_type returned Bitstring).

In BEAM every binary is a bitstring; a Bitstring may be byte-aligned or sub-byte. Call is_binary / to_binary to refine. The NIF API offers no inspection of the sub-byte case.

Implementations

impl<'id> Bitstring<'id>

pub fn from_raw(raw_term: Term) -> Self

Available on crate feature raw only.

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

Returns true if this bitstring is byte-aligned (enif_is_binary).

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

View as a Binary if byte-aligned, else None.

Trait Implementations

impl<'id> Clone for Bitstring<'id>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'id> Copy for Bitstring<'id>

impl Debug for Bitstring<'_>

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

Formats the value using the given formatter.

impl<'id> Decoder<'id> for Bitstring<'id>

Accepts any bitstring (enif_term_type == Bitstring) — both byte-aligned binaries and sub-byte bitstrings. Refine to Binary for the byte-aligned case. WrongType otherwise.

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

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

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

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

Converts to this type from the input type.

impl Ord for Bitstring<'_>

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

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

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