Struct cranelift_entity::SecondaryMap[−][src]

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

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.

Implementations

impl<K, V> SecondaryMap<K, V> where
    K: EntityRef,
    V: Clone, [src]

Shared SecondaryMap implementation for all value types.

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

Create a new empty map.

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

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[src]

Create a new empty map with a specified default value.

This constructor does not require V to implement Default.

pub fn capacity(&self) -> usize[src]

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

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

Get the element at k if it exists.

pub fn is_empty(&self) -> bool[src]

Is this map completely empty?

pub fn clear(&mut self)[src]

Remove all entries from this map.

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

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

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

Iterate over all the keys and values in this map.

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

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

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

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

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

Notable traits for Keys<K>

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

Iterate over all the keys in this map.

pub fn values(&self) -> Iter<'_, V>[src]

Iterate over all the values in this map.

pub fn values_mut(&mut self) -> IterMut<'_, V>[src]

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

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

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

Trait Implementations

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

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

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

impl<K, V> Default for SecondaryMap<K, V> where
    K: EntityRef,
    V: Clone + Default, [src]

fn default() -> SecondaryMap<K, V>[src]

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

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

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[src]

Performs the indexing (container[index]) operation. Read more

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

Mutable indexing into an SecondaryMap.

The map grows as needed to accommodate new keys.

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

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

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

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

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool1.0.0[src]

This method tests for !=.

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

Auto Trait Implementations

impl<K, V> Send for SecondaryMap<K, V> where
    K: Send,
    V: Send, 

impl<K, V> Sync for SecondaryMap<K, V> where
    K: Sync,
    V: Sync, 

impl<K, V> Unpin for SecondaryMap<K, V> where
    K: Unpin,
    V: Unpin, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.