Struct cranelift::prelude::codegen::entity::EntityMap

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

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

The EntityMap data structure uses the dense index space to implement a map with a vector. Unlike PrimaryMap, an EntityMap 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> EntityMap<K, V> where     K: EntityRef,     V: Clone,

Shared EntityMap implementation for all value types.

pub fn new() -> EntityMap<K, V> where     V: Default,

Create a new empty map.

pub fn with_default(default: V) -> EntityMap<K, V>

Create a new empty map with a specified default value.

This constructor does not require V to implement Default.

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, V> Iterator for Iter<'a, K, V> where
    K: EntityRef,  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, V> Iterator for IterMut<'a, K, V> where
    K: EntityRef,  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> Iterator for Keys<K> where
    K: EntityRef,  type Item = K;

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

Iterate over all the keys in this map.

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;

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

Iterate over all the keys in this map.

Important traits for IterMut<'a, T>

impl<'a, T> Iterator for IterMut<'a, T> type Item = &'a mut T;

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

Iterate over all the keys 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, V> IndexMut<K> for EntityMap<K, V> where     K: EntityRef,     V: Clone,

Mutable indexing into an EntityMap.

The map grows as needed to accommodate new keys.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

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

Immutable indexing into an EntityMap.

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

type Output = V

The returned type after indexing.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Performs the indexing (container[index]) operation.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.