Struct Map

pub struct Map<K: Hash + Ord, V> { /* private fields */ }

A basic un-Spanned object/map, with Spanned children.

Implementations

impl<K: Hash + Ord, V> Map<K, V>

pub fn new() -> Self

Makes a new empty Map.

pub fn len(&self) -> usize

Returns the number of elements in the map.

pub fn is_empty(&self) -> bool

true if the map contains no elements.

pub fn clear(&mut self)

Clears the map, removing all elements.

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

Inserts a key-value pair into the map, returning the replaced value, if any.

pub fn entry(&mut self, key: K) -> Entry<'_, K, V>

Gets the given key’s corresponding entry in the map for in-place manipulation.

pub fn contains_key<Q>(&self, key: &Q) -> bool

where Q: Eq + Ord + Hash + ?Sized, K: Borrow<Q>,

true if the map contains the given key.

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

where Q: Eq + Ord + Hash + ?Sized, K: Borrow<Q>,

Return a reference to the value stored for key, if any.

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

where Q: Eq + Ord + Hash + ?Sized, K: Borrow<Q>,

Returns the key-value pair corresponding to the supplied key, if any.

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>

where Q: Eq + Ord + Hash + ?Sized, K: Borrow<Q>,

Returns a mutable reference to the value stored for key, if any.

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

where Q: Eq + Ord + Hash + ?Sized, K: Borrow<Q>,

Removes a key from the map, returning the previous value, if any.

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

where Q: Eq + Ord + Hash + ?Sized, K: Borrow<Q>,

Removes a key from the map, returning the previous key/value pair, if any.

pub fn keys(&self) -> impl Iterator<Item = &K>

Gets an iterator over the keys of the map.

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

Gets an iterator over the values of the map.

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

Gets a mutable iterator over the values of the map.

pub fn iter(&self) -> impl Iterator<Item = (&K, &V)>

Gets an iterator over the entries of the map.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&K, &mut V)>

Gets a mutable iterator over the entries of the map.

Trait Implementations

impl<K: Clone + Hash + Ord, V: Clone> Clone for Map<K, V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Hash + Ord, V: Debug> Debug for Map<K, V>

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

Formats the value using the given formatter.

impl<'de, K: Debug + Hash + Ord + Deserialize<'de>, V: Deserialize<'de>> Deserialize<'de> for Map<K, V>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<'a, K: Hash + Ord + 'a, V: 'a> IntoIterator for &'a Map<K, V>

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

type IntoIter = <&'a IndexMap<K, V> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, K: Hash + Ord + 'a, V: 'a> IntoIterator for &'a mut Map<K, V>

type Item = (&'a K, &'a mut V)

The type of the elements being iterated over.

type IntoIter = <&'a mut IndexMap<K, V> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: Hash + Ord, V> IntoIterator for Map<K, V>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = <IndexMap<K, V> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.