Struct Map 

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

An Erlang map. Immutable — all mutations return a new map.

Implementations

impl<'id> Map<'id>

pub fn from_raw(raw_term: Term) -> Self

Available on crate feature raw only.

pub fn new(env: impl Env<'id>) -> Map<'id>

Create an empty map (enif_make_new_map).

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

Number of key-value pairs (enif_get_map_size).

pub fn get( self, env: impl Env<'id>, key: impl Term<'id>, ) -> Option<AnyTerm<'id>>

Look up key (enif_get_map_value). None if absent.

pub fn put( self, env: impl Env<'id>, key: impl Term<'id>, value: impl Term<'id>, ) -> Map<'id>

Return a new map with key set to value (enif_make_map_put, insert or replace).

pub fn update( self, env: impl Env<'id>, key: impl Term<'id>, value: impl Term<'id>, ) -> Option<Map<'id>>

Return a new map with key updated to value (enif_make_map_update). None if the key is absent.

pub fn remove(self, env: impl Env<'id>, key: impl Term<'id>) -> Map<'id>

Return a new map with key removed (enif_make_map_remove). Removing a key the map does not contain returns it unchanged.

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

Returns true if term is a map (enif_is_map).

pub fn iter(self, env: impl Env<'id>) -> MapIterator<'id>

Iterate (key, value) pairs in unspecified order.

Trait Implementations

impl<'id> Clone for Map<'id>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'id> Copy for Map<'id>

impl Debug for Map<'_>

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

Formats the value using the given formatter.

impl<'id> Decoder<'id> for Map<'id>

Accepts a map (enif_is_map); WrongType otherwise.

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

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

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

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

Converts to this type from the input type.

impl Ord for Map<'_>

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

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

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