Struct elsa::index_map::FrozenIndexMap

pub struct FrozenIndexMap<K, V, S = RandomState> { /* private fields */ }

Append-only version of indexmap::IndexMap where insertion does not require mutable access

Implementations

impl<K: Eq + Hash, V> FrozenIndexMap<K, V>

pub fn new() -> Self

impl<K: Eq + Hash, V: StableDeref, S: BuildHasher> FrozenIndexMap<K, V, S>

pub fn insert(&self, k: K, v: V) -> &V::Target

pub fn insert_full(&self, k: K, v: V) -> (usize, &V::Target)

pub fn get<Q>(&self, k: &Q) -> Option<&V::Target>where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but Hash and Eq on the borrowed form must match those for the key type.

Examples

use elsa::FrozenIndexMap;

let map = FrozenIndexMap::new();
map.insert(1, Box::new("a"));
assert_eq!(map.get(&1), Some(&"a"));
assert_eq!(map.get(&2), None);

pub fn get_index(&self, index: usize) -> Option<(&K::Target, &V::Target)>where K: StableDeref,

pub fn map_get<Q, T, F>(&self, k: &Q, f: F) -> Option<T>where K: Borrow<Q>, Q: Hash + Eq + ?Sized, F: FnOnce(&V) -> T,

Applies a function to the owner of the value corresponding to the key (if any).

The key may be any borrowed form of the map’s key type, but Hash and Eq on the borrowed form must match those for the key type.

Examples

use elsa::FrozenIndexMap;

let map = FrozenIndexMap::new();
map.insert(1, Box::new("a"));
assert_eq!(map.map_get(&1, Clone::clone), Some(Box::new("a")));
assert_eq!(map.map_get(&2, Clone::clone), None);

impl<K, V, S> FrozenIndexMap<K, V, S>

pub fn into_tuple_vec(self) -> Vec<(K, V)>

Collects the contents of this map into a vector of tuples.

The order of the entries is as if iterating an IndexMap.

Examples

use elsa::FrozenIndexMap;

let map = FrozenIndexMap::new();
map.insert(1, Box::new("a"));
map.insert(2, Box::new("b"));
let tuple_vec = map.into_tuple_vec();

assert_eq!(tuple_vec, vec![(1, Box::new("a")), (2, Box::new("b"))]);

pub fn into_map(self) -> IndexMap<K, V, S>

pub fn as_mut(&mut self) -> &mut IndexMap<K, V, S>

Get mutable access to the underlying IndexMap.

This is safe, as it requires a &mut self, ensuring nothing is using the ‘frozen’ contents.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Trait Implementations

impl<K: Eq + Hash, V, S: Default> Default for FrozenIndexMap<K, V, S>

fn default() -> Self

Returns the “default value” for a type.

impl<K, V, S> From<IndexMap<K, V, S>> for FrozenIndexMap<K, V, S>

fn from(map: IndexMap<K, V, S>) -> Self

Converts to this type from the input type.

impl<K: Eq + Hash, V, S: BuildHasher + Default> FromIterator<(K, V)> for FrozenIndexMap<K, V, S>

fn from_iter<T>(iter: T) -> Selfwhere T: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl<Q, K, V, S> Index<&Q> for FrozenIndexMap<K, V, S>where Q: Eq + Hash + ?Sized, K: Eq + Hash + Borrow<Q>, V: StableDeref, S: BuildHasher,

fn index(&self, idx: &Q) -> &V::Target

Examples

use elsa::FrozenIndexMap;

let map = FrozenIndexMap::new();
map.insert(1, Box::new("a"));
assert_eq!(map[&1], "a");

type Output = <V as Deref>::Target

The returned type after indexing.