Struct vec_collections::VecMap

pub struct VecMap<A: Array>(_);

A map backed by a SmallVec of key value pairs.

Implementations

impl<K, V, A: Array<Item = (K, V)>> VecMap<A>

pub fn map_values<R, B: Array<Item = (K, R)>, F: FnMut(V) -> R>(
    self,
    f: F
) -> VecMap<B>

map values while keeping keys

impl<A: Array> VecMap<A>

pub fn is_empty(&self) -> bool

pub fn empty() -> Self

pub fn len(&self) -> usize

number of mappings

pub fn retain<F: FnMut(&A::Item) -> bool>(&mut self, f: F)

retain all pairs matching a predicate

pub fn into_inner(self) -> SmallVec<A>

pub fn single(item: A::Item) -> Self

Creates a vecmap with a single item

impl<K: Ord + 'static, V, A: Array<Item = (K, V)>> VecMap<A>

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

pub fn inner_join_with<W, F>(&mut self, that: &impl AbstractVecMap<K, W>, f: F) where
    K: Ord + Clone,
    F: Fn(&K, V, &W) -> Option<V>, 

pub fn left_join_with<W, F>(&mut self, that: &impl AbstractVecMap<K, W>, f: F) where
    K: Ord + Clone,
    F: Fn(&K, V, Option<&W>) -> Option<V>, 

pub fn right_join_with<W, F>(&mut self, that: &impl AbstractVecMap<K, W>, f: F) where
    K: Ord + Clone,
    F: Fn(&K, Option<V>, &W) -> Option<V>, 

pub fn outer_join_with<W, F>(&mut self, that: &impl AbstractVecMap<K, W>, f: F) where
    K: Ord + Clone,
    F: Fn(OuterJoinArg<&K, V, &W>) -> Option<V>, 

pub fn merge_with<B: Array<Item = (K, V)>>(&mut self, that: VecMap<B>)

in-place merge with another map of the same type. The merge is right-biased, so on collisions the values from the rhs will win.

pub fn combine_with<B: Array<Item = A::Item>, F: Fn(V, V) -> V>(
    &mut self,
    that: VecMap<B>,
    f: F
)

in-place combine with another map of the same type. The given function allows to select the value in case of collisions.

impl<K: Ord + 'static, V, A: Array<Item = (K, V)>> VecMap<A>

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

Trait Implementations

impl<K, V, A: Array<Item = (K, V)>> AbstractVecMap<K, V> for VecMap<A>

fn as_slice(&self) -> &[A::Item]

fn is_empty(&self) -> bool

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

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

lookup of a mapping. Time complexity is O(log N). Binary search.

fn outer_join<W, R, F, A>(
    &self,
    that: &impl AbstractVecMap<K, W>,
    f: F
) -> VecMap<A> where
    K: Ord + Clone,
    A: Array<Item = (K, R)>,
    F: Fn(OuterJoinArg<&K, &V, &W>) -> Option<R>, 

Perform an outer join with another VecMap, producing a new result

fn left_join<W, R, F, A>(
    &self,
    that: &impl AbstractVecMap<K, W>,
    f: F
) -> VecMap<A> where
    K: Ord + Clone,
    F: Fn(&K, &V, Option<&W>) -> Option<R>,
    A: Array<Item = (K, R)>, 

fn right_join<W, R, F, A>(
    &self,
    that: &impl AbstractVecMap<K, W>,
    f: F
) -> VecMap<A> where
    K: Ord + Clone,
    F: Fn(&K, Option<&V>, &W) -> Option<R>,
    A: Array<Item = (K, R)>, 

fn inner_join<W, R, F, A>(
    &self,
    that: &impl AbstractVecMap<K, W>,
    f: F
) -> VecMap<A> where
    K: Ord + Clone,
    F: Fn(&K, &V, &W) -> Option<R>,
    A: Array<Item = (K, R)>, 

impl<A: Array> AsRef<[<A as Array>::Item]> for VecMap<A>

fn as_ref(&self) -> &[A::Item]

Performs the conversion.

impl<T: Clone, A: Array<Item = T>> Clone for VecMap<A>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, A: Array<Item = T>> Debug for VecMap<A>

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

Formats the value using the given formatter.

impl<A: Array> Default for VecMap<A>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K, V, A: Array<Item = (K, V)>> Deserialize<'de> for VecMap<A> where
    K: Deserialize<'de> + Ord + PartialEq + Clone,
    V: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<K: Ord + 'static, V, A: Array<Item = (K, V)>> Extend<<A as Array>::Item> for VecMap<A>

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, V, A: Array<Item = (K, V)>> From<BTreeMap<K, V>> for VecMap<A>

fn from(value: BTreeMap<K, V>) -> Self

Performs the conversion.

impl<A: Array> From<VecMap<A>> for VecSet<A>

fn from(value: VecMap<A>) -> Self

Performs the conversion.

impl<A: Array> From<VecMap<A>> for SmallVec<A>

fn from(value: VecMap<A>) -> Self

Performs the conversion.

impl<K: Ord, V, A: Array<Item = (K, V)>> FromIterator<(K, V)> for VecMap<A>

fn from_iter<I: IntoIterator<Item = A::Item>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Hash, A: Array<Item = T>> Hash for VecMap<A>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a, K: 'a, V: 'a, A: Array<Item = (K, V)>> IntoIterator for &'a VecMap<A>

type Item = &'a A::Item

The type of the elements being iterated over.

type IntoIter = VecMapIter<Iter<'a, A::Item>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<A: Array> IntoIterator for VecMap<A>

type Item = A::Item

The type of the elements being iterated over.

type IntoIter = VecMapIter<IntoIter<A>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord, A: Array<Item = T>> Ord for VecMap<A>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T: PartialEq, A: Array<Item = T>> PartialEq<VecMap<A>> for VecMap<A>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T: PartialOrd, A: Array<Item = T>> PartialOrd<VecMap<A>> for VecMap<A>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<K, V, A: Array<Item = (K, V)>> Serialize for VecMap<A> where
    K: Serialize,
    V: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<T: Eq, A: Array<Item = T>> Eq for VecMap<A>