Struct cranelift_entity::SecondaryMap

pub struct SecondaryMap<K, V> where
    K: EntityRef,
    V: Clone,  { /* fields omitted */ }

A mapping K -> V for densely indexed entity references.

The SecondaryMap data structure uses the dense index space to implement a map with a vector. Unlike PrimaryMap, an SecondaryMap can't be used to allocate entity references. It is used to associate secondary information with entities.

The map does not track if an entry for a key has been inserted or not. Instead it behaves as if all keys have a default entry from the beginning.

Methods

impl<K, V> SecondaryMap<K, V> where
    K: EntityRef,
    V: Clone, 

Shared SecondaryMap implementation for all value types.

pub fn new() -> Self where
    V: Default, 

Create a new empty map.

pub fn with_capacity(capacity: usize) -> Self where
    V: Default, 

Create a new, empty map with the specified capacity.

The map will be able to hold exactly capacity elements without reallocating.

pub fn with_default(default: V) -> Self

Create a new empty map with a specified default value.

This constructor does not require V to implement Default.

pub fn capacity(&self) -> usize

Returns the number of elements the map can hold without reallocating.

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

Get the element at k if it exists.

pub fn is_empty(&self) -> bool

Is this map completely empty?

pub fn clear(&mut self)

Remove all entries from this map.

Important traits for Iter<'a, K, V>

impl<'a, K: EntityRef, V> Iterator for Iter<'a, K, V> type Item = (K, &'a V);

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

Iterate over all the keys and values in this map.

Important traits for IterMut<'a, K, V>

impl<'a, K: EntityRef, V> Iterator for IterMut<'a, K, V> type Item = (K, &'a mut V);

pub fn iter_mut(&mut self) -> IterMut<K, V>

Iterate over all the keys and values in this map, mutable edition.

Important traits for Keys<K>

impl<K: EntityRef> Iterator for Keys<K> type Item = K;

pub fn keys(&self) -> Keys<K>

Iterate over all the keys in this map.

pub fn values(&self) -> Iter<V>

Iterate over all the values in this map.

pub fn values_mut(&mut self) -> IterMut<V>

Iterate over all the values in this map, mutable edition.

pub fn resize(&mut self, n: usize)

Resize the map to have n entries by adding default entries as needed.

Trait Implementations

impl<K: Debug, V: Debug> Debug for SecondaryMap<K, V> where
    K: EntityRef,
    V: Clone, 

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

Formats the value using the given formatter.

impl<K, V> PartialEq<SecondaryMap<K, V>> for SecondaryMap<K, V> where
    K: EntityRef,
    V: Clone + PartialEq, 

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<K, V> Eq for SecondaryMap<K, V> where
    K: EntityRef,
    V: Clone + PartialEq + Eq, 

impl<K, V> Index<K> for SecondaryMap<K, V> where
    K: EntityRef,
    V: Clone, 

Immutable indexing into an SecondaryMap.

All keys are permitted. Untouched entries have the default value.

type Output = V

The returned type after indexing.

fn index(&self, k: K) -> &V

Performs the indexing (container[index]) operation.

impl<K, V> IndexMut<K> for SecondaryMap<K, V> where
    K: EntityRef,
    V: Clone, 

Mutable indexing into an SecondaryMap.

The map grows as needed to accommodate new keys.

fn index_mut(&mut self, k: K) -> &mut V

Performs the mutable indexing (container[index]) operation.

impl<K: Clone, V: Clone> Clone for SecondaryMap<K, V> where
    K: EntityRef,
    V: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.