Struct VecMap 

pub struct VecMap<K: Eq, V: Sized + PartialEq> { /* private fields */ }

A map type backed by a Vector. Useful for small collections whose size can change.

Implementations

impl<K: Eq, V: Sized + PartialEq> VecMap<K, V>

pub fn new() -> VecMap<K, V>

Creates a new, empty VecMap. Calls Vec::new() internally.

pub const unsafe fn from_vec_unchecked(vector: Vec<(K, V)>) -> VecMap<K, V>

Please only use this method to create map literals if the “macros” feature is unavailable to you “macros” provides safe, checked alternatives to initialize linear maps with compile time checking of the invariants of each type.

Creates a new VecMap from the supplied vector.

SAFETY: improper use of this method - initializing with duplicate keys - will NOT create memory unsafety, but will result in every identical key beyond the first never getting accessed as LinearMaps short circuit on the first matching key.

pub fn len(&self) -> usize

Returns the number of elements in the container

pub fn is_empty(&self) -> bool

Returns true if the store is empty, false otherwise.

pub fn with_capacity(capacity: usize) -> VecMap<K, V>

Creates a new, empty VecMap with capacity set to the provide value. Calls Vec::with_capacity() internally.

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

Tries to remove the value associated with the given key, returning None if it is not found.

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

Tries to remove the entry associated with the given key, returning None if it is not found.

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

Inserts the provided value into the VecMap. If the provided key is found it will update the value. and return the old value. If not, this will allocate for a new key value pair.

Trait Implementations

impl<K: Clone + Eq, V: Clone + Sized + PartialEq> Clone for VecMap<K, V>

fn clone(&self) -> VecMap<K, V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Eq, V: Debug + Sized + PartialEq> Debug for VecMap<K, V>

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

Formats the value using the given formatter.

impl<K: Default + Eq, V: Default + Sized + PartialEq> Default for VecMap<K, V>

fn default() -> VecMap<K, V>

Returns the “default value” for a type.

impl<K: Hash + Eq, V: Hash + Sized + PartialEq> Hash for VecMap<K, V>

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<K: Eq, V: Sized + PartialEq> LinearMap<K, V> for VecMap<K, V>

type Backing = Vec<(K, V)>

fn as_slice(&self) -> &[(K, V)]

The keys and values of the map.

fn into_inner(self) -> Self::Backing

Consumes self, returning the underlying store.

fn contains_key(&self, key: &K) -> bool

Returns true if this map contains the given key. False otherwise.

fn contains_value(&self, value: &V) -> bool

Returns true if this map contains a given value. False otherwise.

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

Gets a reference with the associated key. Will return None if that i key is not in the map.

fn get_mut<'a>(&'a mut self, key: &'a K) -> Option<&'a mut V>

Gets a mutable reference with the associated key. Will return None if that key is not in the map.

fn nth_value<'a>(&'a self, index: usize) -> Option<&'a V>

where K: 'a,

Gets a reference to the nth value in the map. Will return None if index is out of bounds.

fn nth_value_mut<'a>(&'a mut self, index: usize) -> Option<&'a mut V>

where K: 'a,

Gets a reference to the nth value in the map. Will return None if index is out of bounds.

fn nth_key<'a>(&'a self, index: usize) -> Option<&'a K>

where V: 'a,

Gets a reference to the nth value in the map. Will return None if index is out of bounds.

fn nth_key_mut<'a>(&'a mut self, index: usize) -> Option<&'a mut K>

where V: 'a,

Gets a reference to the nth key in the map. Will return None if index is out of bounds.

fn replace(&mut self, key: &K, value: V)

Searches for a key == key in the map. If it is present replaces its value with “value”. If not, it does nothing.

fn merge_from_iter<'a>(&'a mut self, iter: impl Iterator<Item = &'a (K, V)>)

where K: 'a, V: 'a + Clone,

For every key in iter which matches a key in self, this method replaces the value from iter in self, “merging” the iterator and the map.

impl<K: Ord + Eq, V: Ord + Sized + PartialEq> Ord for VecMap<K, V>

fn cmp(&self, other: &VecMap<K, V>) -> 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<K: PartialEq + Eq, V: PartialEq + Sized + PartialEq> PartialEq for VecMap<K, V>

fn eq(&self, other: &VecMap<K, V>) -> 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<K: PartialOrd + Eq, V: PartialOrd + Sized + PartialEq> PartialOrd for VecMap<K, V>

fn partial_cmp(&self, other: &VecMap<K, V>) -> 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<K: Eq + Eq, V: Eq + Sized + PartialEq> Eq for VecMap<K, V>

impl<K: Eq, V: Sized + PartialEq> StructuralPartialEq for VecMap<K, V>