Struct OrderedMap

pub struct OrderedMap<K, V> { /* private fields */ }

A map that preserves the insertion order of keys.

Implementations

impl<K, V> OrderedMap<K, V>

pub fn new() -> Self

Creates a new, empty OrderedMap.

pub fn len(&self) -> usize

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

pub fn is_empty(&self) -> bool

Checks if the map is empty.

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

Returns an iterator over the keys.

pub fn clear(&mut self)

Remove all the entries in the map.

impl<K, V> OrderedMap<K, V>

where K: Eq + Hash,

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

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

Retrieves a reference to the value corresponding to the key.

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

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

Retrieves a mutable reference to the value corresponding to the key.

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

Returns the reference to the element with the key at the given position.

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

Returns the mutable reference to the element with the key at the given position.

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

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

Returns true if the map contains the given key.

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

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

Removes a key from the map, returning its value if it was present.

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

Removes the element at the given position.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&K, &mut V) -> bool,

Remove all elements that does not matches the predicate.

pub fn try_retain<F, E>(&mut self, f: F) -> Result<(), E>

where F: FnMut(&K, &mut V) -> Result<bool, E>,

Remove all elements that does not matches the predicate. If the predicate returns an error, the operation is stopped and the error is returned.

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

Returns an iterator over the key-value pairs in insertion order.

impl<K, V> OrderedMap<K, V>

where K: Eq + Hash + Ord,

pub fn sort_keys(&mut self)

Sort the keys of this map.

impl<K, V> OrderedMap<K, V>

where K: Eq + Hash + Clone,

pub fn insert(&mut self, key: K, value: V)

Inserts a key-value pair into the map. If the key is new, it is added to the keys vector to preserve order. If the key already exists, its value is updated.

Trait Implementations

impl<K: Clone, V: Clone> Clone for OrderedMap<K, V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V> Debug for OrderedMap<K, V>

where K: Debug + Eq + Hash, V: Debug,

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

Formats the value using the given formatter.

impl<K, V> Default for OrderedMap<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, K, V> IntoIterator for &'a OrderedMap<K, V>

where K: Eq + Hash,

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<K, V> IntoIterator for OrderedMap<K, V>

where K: Eq + Hash,

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<K, V> PartialEq for OrderedMap<K, V>

where K: Eq + Hash, V: PartialEq,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<K, V> Eq for OrderedMap<K, V>

where K: Eq + Hash, V: PartialEq,