indexmap_amortized::map

Struct IndexMap

Source
pub struct IndexMap<K, V, S = RandomState> { /* private fields */ }
Expand description

A hash table where the iteration order of the key-value pairs is independent of the hash values of the keys.

The interface is closely compatible with the standard HashMap, but also has additional features.

§Order

The key-value pairs have a consistent order that is determined by the sequence of insertion and removal calls on the map. The order does not depend on the keys or the hash function at all.

All iterators traverse the map in the order.

The insertion order is preserved, with notable exceptions like the .remove() or .swap_remove() methods. Methods such as .sort_by() of course result in a new order, depending on the sorting order.

§Indices

The key-value pairs are indexed in a compact range without holes in the range 0..self.len(). For example, the method .get_full looks up the index for a key, and the method .get_index looks up the key-value pair by index.

§Examples

use indexmap_amortized::IndexMap;

// count the frequency of each letter in a sentence.
let mut letters = IndexMap::new();
for ch in "a short treatise on fungi".chars() {
    *letters.entry(ch).or_insert(0) += 1;
}

assert_eq!(letters[&'s'], 2);
assert_eq!(letters[&'t'], 3);
assert_eq!(letters[&'u'], 1);
assert_eq!(letters.get(&'y'), None);

Implementations§

Source§

impl<K, V> IndexMap<K, V>

Source

pub fn new() -> Self

Create a new map. (Does not allocate.)

Source

pub fn with_capacity(n: usize) -> Self

Create a new map with capacity for n key-value pairs. (Does not allocate if n is zero.)

Computes in O(n) time.

Source§

impl<K, V, S> IndexMap<K, V, S>

Source

pub fn with_capacity_and_hasher(n: usize, hash_builder: S) -> Self

Create a new map with capacity for n key-value pairs. (Does not allocate if n is zero.)

Computes in O(n) time.

Source

pub fn with_hasher(hash_builder: S) -> Self

Create a new map with hash_builder

Source

pub fn capacity(&self) -> usize

Computes in O(1) time.

Source

pub fn hasher(&self) -> &S

Return a reference to the map’s BuildHasher.

Source

pub fn len(&self) -> usize

Return the number of key-value pairs in the map.

Computes in O(1) time.

Source

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Computes in O(1) time.

Source

pub fn iter(&self) -> Iter<'_, K, V>

Return an iterator over the key-value pairs of the map, in their order

Source

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>

Return an iterator over the key-value pairs of the map, in their order

Source

pub fn keys(&self) -> Keys<'_, K, V>

Return an iterator over the keys of the map, in their order

Source

pub fn values(&self) -> Values<'_, K, V>

Return an iterator over the values of the map, in their order

Source

pub fn values_mut(&mut self) -> ValuesMut<'_, K, V>

Return an iterator over mutable references to the the values of the map, in their order

Source

pub fn clear(&mut self)

Remove all key-value pairs in the map, while preserving its capacity.

Computes in O(n) time.

Source

pub fn truncate(&mut self, len: usize)

Shortens the map, keeping the first len elements and dropping the rest.

If len is greater than the map’s current length, this has no effect.

Source

pub fn drain<R>(&mut self, range: R) -> Drain<'_, K, V>
where R: RangeBounds<usize>,

Clears the IndexMap in the given index range, returning those key-value pairs as a drain iterator.

The range may be any type that implements RangeBounds<usize>, including all of the std::ops::Range* types, or even a tuple pair of Bound start and end values. To drain the map entirely, use RangeFull like map.drain(..).

This shifts down all entries following the drained range to fill the gap, and keeps the allocated memory for reuse.

Panics if the starting point is greater than the end point or if the end point is greater than the length of the map.

Source

pub fn split_off(&mut self, at: usize) -> Self
where S: Clone,

Splits the collection into two at the given index.

Returns a newly allocated map containing the elements in the range [at, len). After the call, the original map will be left containing the elements [0, at) with its previous capacity unchanged.

Panics if at > len.

Source§

impl<K, V, S> IndexMap<K, V, S>
where K: Hash + Eq, S: BuildHasher,

Source

pub fn reserve(&mut self, additional: usize)

Reserve capacity for additional more key-value pairs.

Computes in O(n) time.

Source

pub fn shrink_to_fit(&mut self)

Shrink the capacity of the map as much as possible.

Computes in O(n) time.

Source

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

Insert a key-value pair in the map.

If an equivalent key already exists in the map: the key remains and retains in its place in the order, its corresponding value is updated with value and the older value is returned inside Some(_).

If no equivalent key existed in the map: the new key-value pair is inserted, last in order, and None is returned.

Computes in O(1) time (amortized average).

See also entry if you you want to insert or modify or if you need to get the index of the corresponding key-value pair.

Source

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

Insert a key-value pair in the map, and get their index.

If an equivalent key already exists in the map: the key remains and retains in its place in the order, its corresponding value is updated with value and the older value is returned inside (index, Some(_)).

If no equivalent key existed in the map: the new key-value pair is inserted, last in order, and (index, None) is returned.

Computes in O(1) time (amortized average).

See also entry if you you want to insert or modify or if you need to get the index of the corresponding key-value pair.

Source

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

Get the given key’s corresponding entry in the map for insertion and/or in-place manipulation.

Computes in O(1) time (amortized average).

Source

pub fn contains_key<Q>(&self, key: &Q) -> bool
where Q: Hash + Equivalent<K> + ?Sized,

Return true if an equivalent to key exists in the map.

Computes in O(1) time (average).

Source

pub fn get<Q>(&self, key: &Q) -> Option<&V>
where Q: Hash + Equivalent<K> + ?Sized,

Return a reference to the value stored for key, if it is present, else None.

Computes in O(1) time (average).

Source

pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>
where Q: Hash + Equivalent<K> + ?Sized,

Return references to the key-value pair stored for key, if it is present, else None.

Computes in O(1) time (average).

Source

pub fn get_full<Q>(&self, key: &Q) -> Option<(usize, &K, &V)>
where Q: Hash + Equivalent<K> + ?Sized,

Return item index, key and value

Source

pub fn get_index_of<Q>(&self, key: &Q) -> Option<usize>
where Q: Hash + Equivalent<K> + ?Sized,

Return item index, if it exists in the map

Source

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>
where Q: Hash + Equivalent<K> + ?Sized,

Source

pub fn get_full_mut<Q>(&mut self, key: &Q) -> Option<(usize, &K, &mut V)>
where Q: Hash + Equivalent<K> + ?Sized,

Source

pub fn remove<Q>(&mut self, key: &Q) -> Option<V>
where Q: Hash + Equivalent<K> + ?Sized,

Remove the key-value pair equivalent to key and return its value.

NOTE: This is equivalent to .swap_remove(key), if you need to preserve the order of the keys in the map, use .shift_remove(key) instead.

Computes in O(1) time (average).

Source

pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>
where Q: Hash + Equivalent<K> + ?Sized,

Remove and return the key-value pair equivalent to key.

NOTE: This is equivalent to .swap_remove_entry(key), if you need to preserve the order of the keys in the map, use .shift_remove_entry(key) instead.

Computes in O(1) time (average).

Source

pub fn swap_remove<Q>(&mut self, key: &Q) -> Option<V>
where Q: Hash + Equivalent<K> + ?Sized,

Remove the key-value pair equivalent to key and return its value.

Like Vec::swap_remove, the pair is removed by swapping it with the last element of the map and popping it off. This perturbs the position of what used to be the last element!

Return None if key is not in map.

Computes in O(1) time (average).

Source

pub fn swap_remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>
where Q: Hash + Equivalent<K> + ?Sized,

Remove and return the key-value pair equivalent to key.

Like Vec::swap_remove, the pair is removed by swapping it with the last element of the map and popping it off. This perturbs the position of what used to be the last element!

Return None if key is not in map.

Computes in O(1) time (average).

Source

pub fn swap_remove_full<Q>(&mut self, key: &Q) -> Option<(usize, K, V)>
where Q: Hash + Equivalent<K> + ?Sized,

Remove the key-value pair equivalent to key and return it and the index it had.

Like Vec::swap_remove, the pair is removed by swapping it with the last element of the map and popping it off. This perturbs the position of what used to be the last element!

Return None if key is not in map.

Computes in O(1) time (average).

Source

pub fn shift_remove<Q>(&mut self, key: &Q) -> Option<V>
where Q: Hash + Equivalent<K> + ?Sized,

Remove the key-value pair equivalent to key and return its value.

Like Vec::remove, the pair is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Return None if key is not in map.

Computes in O(n) time (average).

Source

pub fn shift_remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>
where Q: Hash + Equivalent<K> + ?Sized,

Remove and return the key-value pair equivalent to key.

Like Vec::remove, the pair is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Return None if key is not in map.

Computes in O(n) time (average).

Source

pub fn shift_remove_full<Q>(&mut self, key: &Q) -> Option<(usize, K, V)>
where Q: Hash + Equivalent<K> + ?Sized,

Remove the key-value pair equivalent to key and return it and the index it had.

Like Vec::remove, the pair is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Return None if key is not in map.

Computes in O(n) time (average).

Source

pub fn pop(&mut self) -> Option<(K, V)>

Remove the last key-value pair

Computes in O(1) time (average).

Source

pub fn retain<F>(&mut self, keep: F)
where F: FnMut(&K, &mut V) -> bool,

Scan through each key-value pair in the map and keep those where the closure keep returns true.

The elements are visited in order, and remaining elements keep their order.

Computes in O(n) time (average).

Source

pub fn sort_keys(&mut self)
where K: Ord,

Sort the map’s key-value pairs by the default ordering of the keys.

See sort_by for details.

Source

pub fn sort_by<F>(&mut self, cmp: F)
where F: FnMut(&K, &V, &K, &V) -> Ordering,

Sort the map’s key-value pairs in place using the comparison function compare.

The comparison function receives two key and value pairs to compare (you can sort by keys or values or their combination as needed).

Computes in O(n log n + c) time and O(n) space where n is the length of the map and c the capacity. The sort is stable.

Source

pub fn sorted_by<F>(self, cmp: F) -> IntoIter<K, V>
where F: FnMut(&K, &V, &K, &V) -> Ordering,

Sort the key-value pairs of the map and return a by value iterator of the key-value pairs with the result.

The sort is stable.

Source

pub fn reverse(&mut self)

Reverses the order of the map’s key-value pairs in place.

Computes in O(n) time and O(1) space.

Source§

impl<K, V, S> IndexMap<K, V, S>

Source

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

Get a key-value pair by index

Valid indices are 0 <= index < self.len()

Computes in O(1) time.

Source

pub fn get_index_mut(&mut self, index: usize) -> Option<(&mut K, &mut V)>

Get a key-value pair by index

Valid indices are 0 <= index < self.len()

Computes in O(1) time.

Source

pub fn first(&self) -> Option<(&K, &V)>

Get the first key-value pair

Computes in O(1) time.

Source

pub fn first_mut(&mut self) -> Option<(&K, &mut V)>

Get the first key-value pair, with mutable access to the value

Computes in O(1) time.

Source

pub fn last(&self) -> Option<(&K, &V)>

Get the last key-value pair

Computes in O(1) time.

Source

pub fn last_mut(&mut self) -> Option<(&K, &mut V)>

Get the last key-value pair, with mutable access to the value

Computes in O(1) time.

Source

pub fn swap_remove_index(&mut self, index: usize) -> Option<(K, V)>

Remove the key-value pair by index

Valid indices are 0 <= index < self.len()

Like Vec::swap_remove, the pair is removed by swapping it with the last element of the map and popping it off. This perturbs the position of what used to be the last element!

Computes in O(1) time (average).

Source

pub fn shift_remove_index(&mut self, index: usize) -> Option<(K, V)>

Remove the key-value pair by index

Valid indices are 0 <= index < self.len()

Like Vec::remove, the pair is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Computes in O(n) time (average).

Source

pub fn swap_indices(&mut self, a: usize, b: usize)

Swaps the position of two key-value pairs in the map.

Panics if a or b are out of bounds.

Source§

impl<K, V, S> IndexMap<K, V, S>
where K: Sync, V: Sync,

Parallel iterator methods and other parallel methods.

The following methods require crate feature "rayon".

See also the IntoParallelIterator implementations.

Source

pub fn par_keys(&self) -> ParKeys<'_, K, V>

Return a parallel iterator over the keys of the map.

While parallel iterators can process items in any order, their relative order in the map is still preserved for operations like reduce and collect.

Source

pub fn par_values(&self) -> ParValues<'_, K, V>

Return a parallel iterator over the values of the map.

While parallel iterators can process items in any order, their relative order in the map is still preserved for operations like reduce and collect.

Source§

impl<K, V, S> IndexMap<K, V, S>
where K: Hash + Eq + Sync, V: Sync, S: BuildHasher,

Source

pub fn par_eq<V2, S2>(&self, other: &IndexMap<K, V2, S2>) -> bool
where V: PartialEq<V2>, V2: Sync, S2: BuildHasher + Sync,

Returns true if self contains all of the same key-value pairs as other, regardless of each map’s indexed order, determined in parallel.

Source§

impl<K, V, S> IndexMap<K, V, S>
where K: Send, V: Send,

Requires crate feature "rayon".

Source

pub fn par_values_mut(&mut self) -> ParValuesMut<'_, K, V>

Return a parallel iterator over mutable references to the the values of the map

While parallel iterators can process items in any order, their relative order in the map is still preserved for operations like reduce and collect.

Source§

impl<K, V, S> IndexMap<K, V, S>
where K: Hash + Eq + Send, V: Send, S: BuildHasher,

Source

pub fn par_sort_keys(&mut self)
where K: Ord,

Sort the map’s key-value pairs in parallel, by the default ordering of the keys.

Source

pub fn par_sort_by<F>(&mut self, cmp: F)
where F: Fn(&K, &V, &K, &V) -> Ordering + Sync,

Sort the map’s key-value pairs in place and in parallel, using the comparison function compare.

The comparison function receives two key and value pairs to compare (you can sort by keys or values or their combination as needed).

Source

pub fn par_sorted_by<F>(self, cmp: F) -> IntoParIter<K, V>
where F: Fn(&K, &V, &K, &V) -> Ordering + Sync,

Sort the key-value pairs of the map in parallel and return a by value parallel iterator of the key-value pairs with the result.

Trait Implementations§

Source§

impl<K, V, S> Clone for IndexMap<K, V, S>
where K: Clone, V: Clone, S: Clone,

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K, V, S> Debug for IndexMap<K, V, S>
where K: Debug, V: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<K, V, S> Default for IndexMap<K, V, S>
where S: Default,

Source§

fn default() -> Self

Return an empty IndexMap

Source§

impl<'de, K, V, S> Deserialize<'de> for IndexMap<K, V, S>
where K: Deserialize<'de> + Eq + Hash, V: Deserialize<'de>, S: Default + BuildHasher,

Requires crate feature "serde" or "serde-1"

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'a, K, V, S> Extend<(&'a K, &'a V)> for IndexMap<K, V, S>
where K: Hash + Eq + Copy, V: Copy, S: BuildHasher,

Source§

fn extend<I: IntoIterator<Item = (&'a K, &'a V)>>(&mut self, iterable: I)

Extend the map with all key-value pairs in the iterable.

See the first extend method for more details.

Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl<K, V, S> Extend<(K, V)> for IndexMap<K, V, S>
where K: Hash + Eq, S: BuildHasher,

Source§

fn extend<I: IntoIterator<Item = (K, V)>>(&mut self, iterable: I)

Extend the map with all key-value pairs in the iterable.

This is equivalent to calling insert for each of them in order, which means that for keys that already existed in the map, their value is updated but it keeps the existing order.

New keys are inserted in the order they appear in the sequence. If equivalents of a key occur more than once, the last corresponding value prevails.

Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

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

Source§

fn from_iter<I: IntoIterator<Item = (K, V)>>(iterable: I) -> Self

Create an IndexMap from the sequence of key-value pairs in the iterable.

from_iter uses the same logic as extend. See extend for more details.

Source§

impl<K, V, S> FromParallelIterator<(K, V)> for IndexMap<K, V, S>
where K: Eq + Hash + Send, V: Send, S: BuildHasher + Default + Send,

Requires crate feature "rayon".

Source§

fn from_par_iter<I>(iter: I) -> Self
where I: IntoParallelIterator<Item = (K, V)>,

Creates an instance of the collection from the parallel iterator par_iter. Read more
Source§

impl<K, V, Q, S> Index<&Q> for IndexMap<K, V, S>
where Q: Hash + Equivalent<K> + ?Sized, K: Hash + Eq, S: BuildHasher,

Access IndexMap values corresponding to a key.

§Examples

use indexmap_amortized::IndexMap;

let mut map = IndexMap::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
    map.insert(word.to_lowercase(), word.to_uppercase());
}
assert_eq!(map["lorem"], "LOREM");
assert_eq!(map["ipsum"], "IPSUM");
use indexmap_amortized::IndexMap;

let mut map = IndexMap::new();
map.insert("foo", 1);
println!("{:?}", map["bar"]); // panics!
Source§

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

Returns a reference to the value corresponding to the supplied key.

Panics if key is not present in the map.

Source§

type Output = V

The returned type after indexing.
Source§

impl<K, V, S> Index<usize> for IndexMap<K, V, S>

Access IndexMap values at indexed positions.

§Examples

use indexmap_amortized::IndexMap;

let mut map = IndexMap::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
    map.insert(word.to_lowercase(), word.to_uppercase());
}
assert_eq!(map[0], "LOREM");
assert_eq!(map[1], "IPSUM");
map.reverse();
assert_eq!(map[0], "AMET");
assert_eq!(map[1], "SIT");
map.sort_keys();
assert_eq!(map[0], "AMET");
assert_eq!(map[1], "DOLOR");
use indexmap_amortized::IndexMap;

let mut map = IndexMap::new();
map.insert("foo", 1);
println!("{:?}", map[10]); // panics!
Source§

fn index(&self, index: usize) -> &V

Returns a reference to the value at the supplied index.

Panics if index is out of bounds.

Source§

type Output = V

The returned type after indexing.
Source§

impl<K, V, Q, S> IndexMut<&Q> for IndexMap<K, V, S>
where Q: Hash + Equivalent<K> + ?Sized, K: Hash + Eq, S: BuildHasher,

Access IndexMap values corresponding to a key.

Mutable indexing allows changing / updating values of key-value pairs that are already present.

You can not insert new pairs with index syntax, use .insert().

§Examples

use indexmap_amortized::IndexMap;

let mut map = IndexMap::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
    map.insert(word.to_lowercase(), word.to_string());
}
let lorem = &mut map["lorem"];
assert_eq!(lorem, "Lorem");
lorem.retain(char::is_lowercase);
assert_eq!(map["lorem"], "orem");
use indexmap_amortized::IndexMap;

let mut map = IndexMap::new();
map.insert("foo", 1);
map["bar"] = 1; // panics!
Source§

fn index_mut(&mut self, key: &Q) -> &mut V

Returns a mutable reference to the value corresponding to the supplied key.

Panics if key is not present in the map.

Source§

impl<K, V, S> IndexMut<usize> for IndexMap<K, V, S>

Access IndexMap values at indexed positions.

Mutable indexing allows changing / updating indexed values that are already present.

You can not insert new values with index syntax, use .insert().

§Examples

use indexmap_amortized::IndexMap;

let mut map = IndexMap::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
    map.insert(word.to_lowercase(), word.to_string());
}
let lorem = &mut map[0];
assert_eq!(lorem, "Lorem");
lorem.retain(char::is_lowercase);
assert_eq!(map["lorem"], "orem");
use indexmap_amortized::IndexMap;

let mut map = IndexMap::new();
map.insert("foo", 1);
map[10] = 1; // panics!
Source§

fn index_mut(&mut self, index: usize) -> &mut V

Returns a mutable reference to the value at the supplied index.

Panics if index is out of bounds.

Source§

impl<'de, K, V, S, E> IntoDeserializer<'de, E> for IndexMap<K, V, S>
where K: IntoDeserializer<'de, E> + Eq + Hash, V: IntoDeserializer<'de, E>, S: BuildHasher, E: Error,

Source§

type Deserializer = MapDeserializer<'de, <IndexMap<K, V, S> as IntoIterator>::IntoIter, E>

The type of the deserializer being converted into.
Source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.
Source§

impl<'a, K, V, S> IntoIterator for &'a IndexMap<K, V, S>

Source§

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

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, K, V>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a, K, V, S> IntoIterator for &'a mut IndexMap<K, V, S>

Source§

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

The type of the elements being iterated over.
Source§

type IntoIter = IterMut<'a, K, V>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<K, V, S> IntoIterator for IndexMap<K, V, S>

Source§

type Item = (K, V)

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a, K, V, S> IntoParallelIterator for &'a IndexMap<K, V, S>
where K: Sync, V: Sync,

Requires crate feature "rayon".

Source§

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

The type of item that the parallel iterator will produce.
Source§

type Iter = ParIter<'a, K, V>

The parallel iterator type that will be created.
Source§

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator. Read more
Source§

impl<'a, K, V, S> IntoParallelIterator for &'a mut IndexMap<K, V, S>
where K: Sync + Send, V: Send,

Requires crate feature "rayon".

Source§

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

The type of item that the parallel iterator will produce.
Source§

type Iter = ParIterMut<'a, K, V>

The parallel iterator type that will be created.
Source§

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator. Read more
Source§

impl<K, V, S> IntoParallelIterator for IndexMap<K, V, S>
where K: Send, V: Send,

Requires crate feature "rayon".

Source§

type Item = (K, V)

The type of item that the parallel iterator will produce.
Source§

type Iter = IntoParIter<K, V>

The parallel iterator type that will be created.
Source§

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator. Read more
Source§

impl<K, V, S> MutableKeys for IndexMap<K, V, S>
where K: Eq + Hash, S: BuildHasher,

Opt-in mutable access to keys.

See MutableKeys for more information.

Source§

type Key = K

Source§

type Value = V

Source§

fn get_full_mut2<Q>(&mut self, key: &Q) -> Option<(usize, &mut K, &mut V)>
where Q: Hash + Equivalent<K> + ?Sized,

Return item index, mutable reference to key and value
Source§

fn retain2<F>(&mut self, keep: F)
where F: FnMut(&mut K, &mut V) -> bool,

Scan through each key-value pair in the map and keep those where the closure keep returns true. Read more
Source§

fn __private_marker(&self) -> PrivateMarker

This method is not useful in itself – it is there to “seal” the trait for external implementation, so that we can add methods without causing breaking changes.
Source§

impl<'a, K, V, S> ParallelExtend<(&'a K, &'a V)> for IndexMap<K, V, S>
where K: Copy + Eq + Hash + Send + Sync + 'a, V: Copy + Send + Sync + 'a, S: BuildHasher + Send,

Requires crate feature "rayon".

Source§

fn par_extend<I>(&mut self, iter: I)
where I: IntoParallelIterator<Item = (&'a K, &'a V)>,

Extends an instance of the collection with the elements drawn from the parallel iterator par_iter. Read more
Source§

impl<K, V, S> ParallelExtend<(K, V)> for IndexMap<K, V, S>
where K: Eq + Hash + Send, V: Send, S: BuildHasher + Send,

Requires crate feature "rayon".

Source§

fn par_extend<I>(&mut self, iter: I)
where I: IntoParallelIterator<Item = (K, V)>,

Extends an instance of the collection with the elements drawn from the parallel iterator par_iter. Read more
Source§

impl<K, V1, S1, V2, S2> PartialEq<IndexMap<K, V2, S2>> for IndexMap<K, V1, S1>
where K: Hash + Eq, V1: PartialEq<V2>, S1: BuildHasher, S2: BuildHasher,

Source§

fn eq(&self, other: &IndexMap<K, V2, S2>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<K, V, S> Serialize for IndexMap<K, V, S>
where K: Serialize + Hash + Eq, V: Serialize, S: BuildHasher,

Requires crate feature "serde" or "serde-1"

Source§

fn serialize<T>(&self, serializer: T) -> Result<T::Ok, T::Error>
where T: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<K, V, S> Eq for IndexMap<K, V, S>
where K: Eq + Hash, V: Eq, S: BuildHasher,

Auto Trait Implementations§

§

impl<K, V, S> Freeze for IndexMap<K, V, S>
where S: Freeze,

§

impl<K, V, S> RefUnwindSafe for IndexMap<K, V, S>

§

impl<K, V, S> Send for IndexMap<K, V, S>
where S: Send, K: Send, V: Send,

§

impl<K, V, S> Sync for IndexMap<K, V, S>
where S: Sync, K: Sync, V: Sync,

§

impl<K, V, S> Unpin for IndexMap<K, V, S>
where S: Unpin, K: Unpin, V: Unpin,

§

impl<K, V, S> UnwindSafe for IndexMap<K, V, S>
where S: UnwindSafe, K: UnwindSafe, V: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<'data, I> IntoParallelRefIterator<'data> for I
where I: 'data + ?Sized, &'data I: IntoParallelIterator,

Source§

type Iter = <&'data I as IntoParallelIterator>::Iter

The type of the parallel iterator that will be returned.
Source§

type Item = <&'data I as IntoParallelIterator>::Item

The type of item that the parallel iterator will produce. This will typically be an &'data T reference type.
Source§

fn par_iter(&'data self) -> <I as IntoParallelRefIterator<'data>>::Iter

Converts self into a parallel iterator. Read more
Source§

impl<'data, I> IntoParallelRefMutIterator<'data> for I

Source§

type Iter = <&'data mut I as IntoParallelIterator>::Iter

The type of iterator that will be created.
Source§

type Item = <&'data mut I as IntoParallelIterator>::Item

The type of item that will be produced; this is typically an &'data mut T reference.
Source§

fn par_iter_mut( &'data mut self, ) -> <I as IntoParallelRefMutIterator<'data>>::Iter

Creates the parallel iterator from self. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,