Skip to main content

OrderedMap

Struct OrderedMap 

Source
pub struct OrderedMap<V> { /* private fields */ }
Expand description

A map from strings to V that keeps its keys in the order they were inserted. Lookups are O(1): small maps scan their few entries, and larger ones keep a hash index of positions. Inserting or removing at a position shifts the entries after it, in O(n).

Two maps are equal when they have the same keys with equal values, in any order.

Implementations§

Source§

impl<V> OrderedMap<V>

Source

pub fn new() -> Self

Source

pub fn with_capacity(capacity: usize) -> Self

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn position(&self, key: &str) -> Option<usize>

The position of key.

Source

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

Source

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

Source

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

Source

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

The entry at index, in order.

Source

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

Sets key to value, returning the value it replaced. A new key goes last; an existing one keeps its place.

Source

pub fn insert_at(&mut self, at: usize, key: impl Into<String>, value: V)

Inserts key, which must not be present yet, at position at, shifting the entries after it.

Source

pub fn remove_full(&mut self, key: &str) -> Option<(usize, V)>

Removes key, returning its position and value. The other keys keep their order.

Source

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

Removes key, returning its value. The other keys keep their order.

Source

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

The entries, in order.

Source

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

The entries, in order, with mutable values.

Source

pub fn keys( &self, ) -> impl DoubleEndedIterator<Item = &String> + ExactSizeIterator + Clone

Source

pub fn values( &self, ) -> impl DoubleEndedIterator<Item = &V> + ExactSizeIterator + Clone

Source

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

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<V: Debug> Debug for OrderedMap<V>

Source§

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

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

impl<V> Default for OrderedMap<V>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<K: Into<String>, V> FromIterator<(K, V)> for OrderedMap<V>

Source§

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

A key that repeats keeps its first place and its last value.

Source§

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

Source§

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

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, V>

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

fn into_iter(self) -> Iter<'a, V> ⓘ

Creates an iterator from a value. Read more
Source§

impl<V> IntoIterator for OrderedMap<V>

Source§

type Item = (String, V)

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<V>

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

fn into_iter(self) -> IntoIter<V> ⓘ

Creates an iterator from a value. Read more
Source§

impl<V: PartialEq> PartialEq for OrderedMap<V>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Auto Trait Implementations§

§

impl<V> Forget for OrderedMap<V>

§

impl<V> Freeze for OrderedMap<V>
where Vec<V>: Freeze,

§

impl<V> Move for OrderedMap<V>

§

impl<V> RefUnwindSafe for OrderedMap<V>
where Vec<V>: RefUnwindSafe,

§

impl<V> Send for OrderedMap<V>
where Vec<V>: Send,

§

impl<V> Sync for OrderedMap<V>
where Vec<V>: Sync,

§

impl<V> Unpin for OrderedMap<V>
where Vec<V>: Unpin,

§

impl<V> UnsafeUnpin for OrderedMap<V>
where Vec<V>: UnsafeUnpin,

§

impl<V> UnwindSafe for OrderedMap<V>
where Vec<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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.