Struct VecMap

pub struct VecMap<K, V>(/* private fields */);

An mapping of key/value pairs stored as pairs ordered by their key in a Vec.

This is always efficient for small sizes of mappings, and efficient for large sizes when insertion is not needed (i.e. items are placed into the mapping in bulk).

Implementations

impl<K: Eq + PartialEq + Ord + PartialOrd, V> VecMap<K, V>

pub fn new() -> Self

Create a new, empty instance.

pub fn from_sorted(v: Vec<(K, V)>) -> Result<Self, ()>

Create a new instance from a sorted Vec.

Returns Ok with an instance containing the same items as v, or Err if v is unsorted.

pub fn len(&self) -> usize

Return the number of items this mapping contains.

pub fn is_empty(&self) -> bool

Return true if this mapping is empty.

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

Return an iterator over the key/value pairs in this mapping in order.

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

Return an iterator over the keys in this mapping in order.

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

Return an iterator over the values in this mapping in order of their corresponding key.

pub fn get(&self, k: &K) -> Option<&V>

Get the value of the pair with a particular key.

Returns a reference the value of the item in the mapping whose key equals k.

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

Get a mutable reference to the value of the pair with a particular key.

Returns a mutable reference the value of the item in the mapping whose key equals k.

pub fn map<U>(self, f: impl FnMut(K, V) -> U) -> Vec<U>

Consume this mapping and return a Vec of transformed pairs.

Returns the Vec of the resultant values of applying f to each pair in the mapping in order.

pub fn map_ref<U>(&self, f: impl FnMut(&K, &V) -> U) -> Vec<U>

Transform all pairs by reference and return a Vec with the results.

Returns the Vec of the resultant values of applying f to each pair by reference in the mapping in order.

pub fn to_vec(&self) -> Vec<(K, V)>

where K: Clone, V: Clone,

Return a Vec of sorted key/value pairs by cloning this mapping.

pub fn into_vec(self) -> Vec<(K, V)>

Return the Vec of sorted key/value pairs by consuming this mapping.

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

Insert pair into the mapping.

Inserts some pair (k, v) into the mapping, replacing the existing pair whose key is k, if any.

Returns Some value which was replaced, if any.

NOTE: This does an ordered insert and thus is slow. If you’re inserting multiple items, use Self::extend which is much more efficient or consider using an alternative data structure if you’re doing this a lot.

pub fn extend(&mut self, iter: impl IntoIterator<Item = (K, V)>)

Insert multiple pairs from an iterator.

Replaces any existing pairs which share a key with an element of the iterator.

pub fn contains_key(&self, k: &K) -> bool

Check if a key is in the mapping.

Returns true iff the mapping contains a pair whose key equals k.

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

Remove an item from the mapping by key.

Removes the item with key equal to k from the mapping.

Returns the value of the item removed, if any.

pub fn retain(&mut self, f: impl FnMut(&K, &V) -> bool)

Filter items from the mapping.

Removes all pairs from the mapping for which f returns false.

pub fn is_disjoint(&self, other: &VecMap<K, V>) -> bool

where V: Ord,

Compares the pairs in two mappings.

Returns true iff every pair in the mapping is not found in other.

pub fn keys_disjoint<W>(&self, other: &VecMap<K, W>) -> bool

Compares the keys in two mappings.

Returns true iff every key in the mapping is not found in the keys of other.

pub fn keys_disjoint_with_set(&self, other: &VecSet<K>) -> bool

Compares the keys in this mapping with the values in a set.

Returns true iff every key in the mapping is not found in other.

Trait Implementations

impl<K, V> AsMut<[(K, V)]> for VecMap<K, V>

fn as_mut(&mut self) -> &mut [(K, V)]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<K, V> AsRef<[(K, V)]> for VecMap<K, V>

fn as_ref(&self) -> &[(K, V)]

Converts this type into a shared reference of the (usually inferred) input type.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for VecMap<K, V>

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

Formats the value using the given formatter.

impl<K: Decode + Eq + PartialEq + Ord + PartialOrd, V: Decode> Decode for VecMap<K, V>

fn decode<I: Input>(input: &mut I) -> Result<Self, DecodeError>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

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

fn default() -> Self

Returns the “default value” for a type.

impl<K: Display, V: Display> Display for VecMap<K, V>

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

Formats the value using the given formatter.

impl<K, V> Encode for VecMap<K, V>

where Vec<(K, V)>: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<__CodecOutputReturn, __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<K: Eq + PartialEq + Ord + PartialOrd, V> Extend<(K, V)> for VecMap<K, V>

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

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.

impl<K: Eq + PartialEq + Ord + PartialOrd, V> From<Vec<(K, V)>> for VecMap<K, V>

fn from(v: Vec<(K, V)>) -> Self

Converts to this type from the input type.

impl<K, V> From<VecMap<K, V>> for Vec<(K, V)>

fn from(s: VecMap<K, V>) -> Vec<(K, V)>

Converts to this type from the input type.

impl<K: Eq + PartialEq + Ord + PartialOrd, V> FromIterator<(K, V)> for VecMap<K, V>

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

Creates a value from an iterator.

impl<K: Eq + PartialEq + Ord + PartialOrd, V> IntoIterator for VecMap<K, V>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = <Vec<(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: Eq + PartialEq + Ord + PartialOrd, V> MapLike<K, V> for VecMap<K, V>

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

Insert pair into the mapping.

fn extend(&mut self, iter: impl Iterator<Item = (K, V)>)

Insert multiple pairs from an iterator.

fn contains_key(&self, k: &K) -> bool

Check if a key is in the mapping.

fn remove(&mut self, k: &K) -> Option<V>

Remove an item from the mapping by key.

fn get(&self, k: &K) -> Option<&V>

Get the value of the pair with a particular key.

fn get_mut(&mut self, k: &K) -> Option<&mut V>

Get a mutable reference to the value of the pair with a particular key.

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

where K: 'a,

Get an iterator to all keys in the mapping.

impl<K: Ord, V: Ord> Ord for VecMap<K, V>

fn cmp(&self, other: &VecMap<K, V>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<K: PartialEq, V: PartialEq> PartialEq for VecMap<K, V>

fn eq(&self, other: &VecMap<K, V>) -> 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: PartialOrd, V: PartialOrd> PartialOrd for VecMap<K, V>

fn partial_cmp(&self, other: &VecMap<K, V>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<K, V> EncodeLike for VecMap<K, V>

where Vec<(K, V)>: Encode,

impl<K: Eq, V: Eq> Eq for VecMap<K, V>

impl<K, V> StructuralPartialEq for VecMap<K, V>