Struct linear_collections::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 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 len(&self) -> usize

Returns the number of entries in the map

pub fn is_empty(&self) -> bool

Returns true if the store is empty, false otherwise.

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: 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.