Struct mtots_core::GMap

pub struct GMap<S, K, V, EqF, HashF, E> where
    EqF: FailableEq<S, K, E>,
    HashF: FailableHash<S, K, E>,  { /* fields omitted */ }

Implementations

impl<K, V, S, EqF, HashF, E> GMap<S, K, V, EqF, HashF, E> where
    EqF: FailableEq<S, K, E>,
    HashF: FailableHash<S, K, E>, 

pub fn new() -> GMap<S, K, V, EqF, HashF, E>

pub fn change_count(&self) -> usize

Returns the number of changes made to the map since it was created This can be used to detect whether a given map has been mutated over time

pub fn s_insert(
    &mut self,
    state: &mut S,
    key: K,
    value: V
) -> Result<Option<V>, E>

pub fn s_remove(&mut self, state: &mut S, key: &K) -> Result<Option<V>, E>

pub fn s_get(&self, state: &mut S, key: &K) -> Result<Option<&V>, E>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn reserved_entries_count(&self) -> usize

Should almost never need to be used See doc on method get_pair_at_index

pub fn get_pair_at_index(&self, i: usize) -> Option<&(K, V)>

This will retrieve the (key, value) pair at the given index This is a semi-private method in the sense that, you normally should never really need it However, this method, together with reserved_entries_count is needed for implementing Map iterators in mtots

pub fn s_eq<EqVF>(&self, state: &mut S, other: &Self) -> Result<bool, E> where
    EqVF: FailableEq<S, V, E>, 

pub fn iter(&self) -> GMapRefIter<K, V>

pub fn keys(&self) -> GMapRefKeysIter<K, V>

impl<K, V> GMap<(), K, V, DefaultEqF<K>, DefaultHashF<K>, ()> where
    K: Eq + Hash, 

Some convenience methods for the default case

pub fn get(&self, key: &K) -> Option<&V>

pub fn insert(&mut self, key: K, value: V) -> Option<V>

pub fn remove(&mut self, key: &K) -> Option<V>

Trait Implementations

impl<K, V, S, EqF, HashF, E> Clone for GMap<S, K, V, EqF, HashF, E> where
    EqF: FailableEq<S, K, E>,
    HashF: FailableHash<S, K, E>,
    K: Clone,
    V: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V, S, EqF, HashF, E> Debug for GMap<S, K, V, EqF, HashF, E> where
    EqF: FailableEq<S, K, E>,
    HashF: FailableHash<S, K, E>,
    K: Debug,
    V: Debug, 

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

Formats the value using the given formatter.

impl From<GMap<Globals, Value, (), Eval, Eval, ErrorIndicator>> for Value

fn from(set: VSet) -> Value

Performs the conversion.

impl From<GMap<Globals, Value, Value, Eval, Eval, ErrorIndicator>> for Value

fn from(map: VMap) -> Value

Performs the conversion.

impl<S, K, V, EqF, HashF, E> IntoIterator for GMap<S, K, V, EqF, HashF, E> where
    EqF: FailableEq<S, K, E>,
    HashF: FailableHash<S, K, E>, 

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = GMapIntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> GMapIntoIter<K, V>

Creates an iterator from a value.

impl<'a, S, K, V, EqF, HashF, E> IntoIterator for &'a GMap<S, K, V, EqF, HashF, E> where
    EqF: FailableEq<S, K, E>,
    HashF: FailableHash<S, K, E>, 

type Item = &'a (K, V)

The type of the elements being iterated over.

type IntoIter = GMapRefIter<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> GMapRefIter<'a, K, V>

Creates an iterator from a value.

impl<K, V> PartialEq<GMap<(), K, V, DefaultEqF<K>, DefaultHashF<K>, ()>> for HMap<K, V> where
    K: Eq + Hash,
    V: PartialEq, 

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.