Struct GenericTokenValueMap 

pub struct GenericTokenValueMap<D: DataSystem> { /* private fields */ }

A collection of named values indexed by string tokens.

This is the generic version of TokenValueMap that works with any DataSystem. Use this when you have a custom data type system.

For the built-in types, use TokenValueMap which is an alias for GenericTokenValueMap<Data>.

Implementations

impl<D: DataSystem> GenericTokenValueMap<D>

pub fn new() -> Self

Creates a new empty map.

pub fn with_capacity(capacity: usize) -> Self

Creates a new map with the specified capacity.

pub fn insert( &mut self, token: impl Into<Token>, value: impl Into<GenericValue<D>>, )

Inserts a value with the given token.

pub fn get(&self, token: &Token) -> Option<&GenericValue<D>>

Gets a reference to the value for a token.

pub fn get_mut(&mut self, token: &Token) -> Option<&mut GenericValue<D>>

Gets a mutable reference to the value for a token.

pub fn remove(&mut self, token: &Token) -> Option<GenericValue<D>>

Removes and returns the value for a token.

pub fn contains(&self, token: &Token) -> bool

Returns true if the map contains the given token.

pub fn len(&self) -> usize

Returns the number of entries in the map.

pub fn is_empty(&self) -> bool

Returns true if the map is empty.

pub fn clear(&mut self)

Removes all entries from the map.

pub fn iter(&self) -> impl Iterator<Item = (&Token, &GenericValue<D>)>

Iterates over all token-value pairs.

pub fn iter_mut( &mut self, ) -> impl Iterator<Item = (&Token, &mut GenericValue<D>)>

Iterates mutably over all token-value pairs.

pub fn tokens(&self) -> impl Iterator<Item = &Token>

Iterates over all tokens.

pub fn values(&self) -> impl Iterator<Item = &GenericValue<D>>

Iterates over all values.

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut GenericValue<D>>

Iterates mutably over all values.

pub fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = (Token, GenericValue<D>)>,

Extends the map with the given iterator.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&Token, &GenericValue<D>) -> bool,

Retains only the entries for which the predicate returns true.

Trait Implementations

impl<D: Clone + DataSystem> Clone for GenericTokenValueMap<D>

fn clone(&self) -> GenericTokenValueMap<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug + DataSystem> Debug for GenericTokenValueMap<D>

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

Formats the value using the given formatter.

impl<D: DataSystem> Default for GenericTokenValueMap<D>

fn default() -> Self

Returns the “default value” for a type.

impl<D: DataSystem, const N: usize> From<[(Token, GenericValue<D>); N]> for GenericTokenValueMap<D>

fn from(arr: [(Token, GenericValue<D>); N]) -> Self

Converts to this type from the input type.

impl<D: DataSystem> FromIterator<(Token, GenericValue<D>)> for GenericTokenValueMap<D>

fn from_iter<T: IntoIterator<Item = (Token, GenericValue<D>)>>(iter: T) -> Self

Creates a value from an iterator.

impl<D: DataSystem> Hash for GenericTokenValueMap<D>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<D: PartialEq + DataSystem> PartialEq for GenericTokenValueMap<D>

fn eq(&self, other: &GenericTokenValueMap<D>) -> 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<D: DataSystem> Eq for GenericTokenValueMap<D>

impl<D: DataSystem> StructuralPartialEq for GenericTokenValueMap<D>