Struct ordermap::OrderMap

pub struct OrderMap<K, V, S = RandomState> { /* fields omitted */ }

A hash map with consistent order of the key-value pairs.

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 same order.

Methods

impl<K, V> OrderMap<K, V>

fn new() -> Self

fn with_capacity(n: usize) -> Self

impl<K, V, S> OrderMap<K, V, S>

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

fn len(&self) -> usize

fn capacity(&self) -> usize

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

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

FIXME Entry API does not implement all hash map's methods yet.

fn clear(&mut self)

fn reserve(&mut self, additional: usize)

FIXME Not implemented fully yet

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

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

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

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

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

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

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

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

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

fn get_pair<Q: ?Sized>(&self, key: &Q) -> Option<(&K, &V)> where K: Borrow<Q>, Q: Eq + Hash

fn get_pair_index<Q: ?Sized>(&self, key: &Q) -> Option<(usize, &K, &V)> where K: Borrow<Q>, Q: Eq + Hash

Return item index, key and value

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

fn get_pair_mut<Q: ?Sized>(&mut self, key: &Q) -> Option<(&mut K, &mut V)> where K: Borrow<Q>, Q: Eq + Hash

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

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

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 postion of what used to be the last element!

Return None if key is not in map.

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

FIXME Same as .swap_remove

fn swap_remove_pair<Q: ?Sized>(&mut self, key: &Q) -> Option<(K, V)> where K: Borrow<Q>, Q: Eq + Hash

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

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 postion of what used to be the last element!

Return None if key is not in map.

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

Remove the last key-value pair

impl<K, V, S> OrderMap<K, V, S>

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

Get a key-value pair by index

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

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()

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()

Trait Implementations

impl<K: Clone, V: Clone, S: Clone> Clone for OrderMap<K, V, S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<'a, K, V, S> IntoIterator for &'a OrderMap<K, V, S> where K: Hash + Eq, S: BuildHasher

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

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, K, V, S> IntoIterator for &'a mut OrderMap<K, V, S> where K: Hash + Eq, S: BuildHasher

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

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Output = V

The returned type after indexing

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

The method for the indexing (container[index]) operation

impl<'a, K, V, Q: ?Sized, S> IndexMut<&'a Q> for OrderMap<K, V, S> where K: Eq + Hash, K: Borrow<Q>, Q: Eq + Hash, S: BuildHasher

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().

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

The method for the mutable indexing (container[index]) operation

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

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

Creates a value from an iterator.

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

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

Extends a collection with the contents of an iterator.

impl<K, V, S> Default for OrderMap<K, V, S> where S: BuildHasher + Default

fn default() -> Self

Returns the "default value" for a type.