Struct starlark::collections::small_map::SmallMap

#[repr(C)]
pub struct SmallMap<K, V> { /* private fields */ }

An memory-efficient key-value map with determinstic order.

Provides the standard container operations, modelled most closely on IndexMap, plus:

• Variants which take an already hashed value, e.g. get_hashed.

• Functions which work with the position, e.g. get_index_of.

Implementations

impl<K, V> SmallMap<K, V>

pub const fn new() -> Self

Empty map.

pub fn with_capacity(n: usize) -> Self

Create an empty map with specified capacity.

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

Key references iterator.

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

Value references iterator.

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

Mutable value references iterator.

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

Entry references iterator.

pub fn iter_hashed(
    &self
) -> impl ExactSizeIterator<Item = (BorrowHashed<'_, K>, &V)>

Entry references with hashes iterator.

pub fn into_iter_hashed(self) -> impl ExactSizeIterator<Item = (Hashed<K>, V)>

Entries with hashes iterator.

pub fn iter_mut(&mut self) -> MHIterMut<'_, K, V>

Mutable entry references iterator.

pub fn into_iter(self) -> MHIntoIter<K, V>

Entries iterator.

pub fn get_hashed<Q>(&self, key: BorrowHashed<'_, Q>) -> Option<&V> where
    Q: Equivalent<K> + ?Sized,
    K: Eq, 

Query the map by a prehashed key.

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

Query the map by a given key.

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

Query the map by a given key, return an index of the entry along with the entry key and value.

pub fn get_index_of_hashed<Q>(&self, key: BorrowHashed<'_, Q>) -> Option<usize> where
    Q: Equivalent<K> + ?Sized,
    K: Eq, 

Find the index of the given hashed key.

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

Find an entry by an index.

pub fn get_index_of<Q>(&self, key: &Q) -> Option<usize> where
    Q: Hash + Equivalent<K> + ?Sized,
    K: Eq, 

The an entry index by a given key.

pub fn get_mut_hashed<Q>(&mut self, key: BorrowHashed<'_, Q>) -> Option<&mut V> where
    Q: Equivalent<K> + ?Sized,
    K: Eq, 

Find a mutable value by a hashed key.

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

Find the entry by a given key.

pub fn contains_key_hashed<Q>(&self, key: BorrowHashed<'_, Q>) -> bool where
    Q: Equivalent<K> + ?Sized,
    K: Eq, 

Find if an entry by a given prehashed key exists.

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

Find if an entry by a given key exists.

pub fn reserve(&mut self, additional: usize) where
    K: Eq, 

Reserve capacity for at least additional more elements to be inserted.

pub fn capacity(&self) -> usize

Current map capacity.

pub fn insert_hashed(&mut self, key: Hashed<K>, val: V) -> Option<V> where
    K: Eq, 

Insert a key-value pair into the map.

pub fn insert(&mut self, key: K, val: V) -> Option<V> where
    K: Hash + Eq, 

Insert a key-value pair into the map.

pub fn remove_hashed<Q>(&mut self, key: BorrowHashed<'_, Q>) -> Option<V> where
    Q: ?Sized + Equivalent<K>,
    K: Eq, 

Remove the entry for the key.

This operation is linear in the number of entries in the map.

pub fn remove_hashed_entry<Q>(
    &mut self,
    key: BorrowHashed<'_, Q>
) -> Option<(K, V)> where
    Q: ?Sized + Equivalent<K>,
    K: Eq, 

Remove the entry for the key.

This operation is linear in the number of entries in the map.

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

Remove the entry for the key.

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

Remove the entry for the key.

pub fn entry_hashed(&mut self, key: Hashed<K>) -> Entry<'_, K, V> where
    K: Eq, 

Get the entry (occupied or not) for the key.

pub fn pop(&mut self) -> Option<(K, V)> where
    K: Eq, 

Remove the last element.

pub fn entry(&mut self, key: K) -> Entry<'_, K, V> where
    K: Eq + Hash, 

Get the entry (occupied or not) for the key.

pub fn is_empty(&self) -> bool

Is the map empty?

pub fn len(&self) -> usize

Get the number of elements in the map.

pub fn clear(&mut self)

Remove all elements from the map.

Retain the capacity.

Trait Implementations

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

fn clone(&self) -> SmallMap<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 SmallMap<K, V>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<K, V> Freeze for SmallMap<K, V> where
    K: Freeze,
    V: Freeze, 

type Frozen = SmallMap<K::Frozen, V::Frozen>

When type is frozen, it is frozen into this type.

fn freeze(self, freezer: &Freezer) -> Result<SmallMap<K::Frozen, V::Frozen>>

Freeze a value. The frozen value must be equal to the original, and produce the same hash.

impl<K, V> FromIterator<(Hashed<K>, V)> for SmallMap<K, V> where
    K: Eq, 

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

Creates a value from an iterator.

impl<K, V> FromIterator<(K, V)> for SmallMap<K, V> where
    K: Hash + Eq, 

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

Creates a value from an iterator.

impl<K: Hash, V: Hash> Hash for SmallMap<K, V>

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

The hash of a map is the sum of hashes of all its elements, so that we guarantee equal hash means equals

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

Feeds a slice of this type into the given Hasher.

impl<K, V> IntoIterator for SmallMap<K, V>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = MHIntoIter<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> IntoIterator for &'a SmallMap<K, V>

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

The type of the elements being iterated over.

type IntoIter = MHIter<'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> IntoIterator for &'a mut SmallMap<K, V>

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

The type of the elements being iterated over.

type IntoIter = MHIterMut<'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: Ord, V: Ord> Ord for SmallMap<K, V>

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<K: Eq, V: PartialEq> PartialEq<SmallMap<K, V>> for SmallMap<K, V>

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<K: PartialOrd + Eq, V: PartialOrd> PartialOrd<SmallMap<K, V>> for SmallMap<K, V>

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<'v, K: Trace<'v>, V: Trace<'v>> Trace<'v> for SmallMap<K, V>

fn trace(&mut self, tracer: &Tracer<'v>)

Recursively “trace” the value.

impl<'v, K: UnpackValue<'v> + Hash + Eq, V: UnpackValue<'v>> UnpackValue<'v> for SmallMap<K, V>

fn expected() -> String

Description of values acceptable by unpack_value, e. g. list or str.

fn unpack_value(value: Value<'v>) -> Option<Self>

Given a Value, try and unpack it into the given type, which may involve some element of conversion. The heap argument is usually not required.

fn unpack_param(value: Value<'v>) -> Result<Self>

Unpack value, but instead of None return error about incorrect argument type.

fn unpack_named_param(value: Value<'v>, param_name: &str) -> Result<Self>

Unpack value, but instead of None return error about incorrect named argument type.

impl<FromK, FromV, ToK, ToV> Coerce<SmallMap<ToK, ToV>> for SmallMap<FromK, FromV> where
    FromK: CoerceKey<ToK>,
    FromV: Coerce<ToV>, 

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