Struct KeyedVec 

pub struct KeyedVec<Key, Value> { /* private fields */ }

Structure for storing elements of type Value, the structure can only be indexed by structures of type Key.

Almost all features of this structure require that Key implements the StorageKey trait.

Implementations

impl<Key, Value> KeyedVec<Key, Value>

where Key: StorageKey,

pub fn push(&mut self, value: Value) -> Key

Add a new value to the vector.

Returns the key for the inserted value.

pub fn new_slot(&mut self) -> Slot<'_, Key, Value>

Create a new slot for a value, and populate it using Slot::populate().

This allows initializing the value with the ID it will have in this vector.

Example

#[derive(Clone)]
struct Key(usize);

impl StorageKey for Key {
    // ...
}

struct Value;

/// Create a value based on the specified key.
fn create_value(key: Key) -> Value {
    // ...
}

let mut keyed_vec: KeyedVec<Key, Value> = KeyedVec::default();

// Reserve a slot.
let slot = keyed_vec.new_slot();
// Create the value.
let value = create_value(slot.key());
// Populate the slot.
slot.populate(value);

pub fn iter(&self) -> impl Iterator<Item = &Value>

Iterate over the values in the vector.

Trait Implementations

impl<Key, Value> Clone for KeyedVec<Key, Value>

where Value: Clone,

fn clone(&self) -> KeyedVec<Key, Value>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Key, Value> Debug for KeyedVec<Key, Value>

where Key: Debug, Value: Debug,

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

Formats the value using the given formatter.

impl<Key, Value> Default for KeyedVec<Key, Value>

fn default() -> KeyedVec<Key, Value>

Returns the “default value” for a type.

impl<Key, Value> Hash for KeyedVec<Key, Value>

where Key: Hash, Value: Hash,

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Key, Value> Index<&Key> for KeyedVec<Key, Value>

where Key: StorageKey,

type Output = Value

The returned type after indexing.

fn index(&self, index: &Key) -> &<KeyedVec<Key, Value> as Index<&Key>>::Output

Performs the indexing (container[index]) operation.

impl<Key, Value> Index<Key> for KeyedVec<Key, Value>

where Key: StorageKey,

type Output = Value

The returned type after indexing.

fn index(&self, index: Key) -> &<KeyedVec<Key, Value> as Index<Key>>::Output

Performs the indexing (container[index]) operation.

impl<Key, Value> IndexMut<Key> for KeyedVec<Key, Value>

where Key: StorageKey,

fn index_mut( &mut self, index: Key, ) -> &mut <KeyedVec<Key, Value> as Index<Key>>::Output

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

impl<Key, Value> PartialEq for KeyedVec<Key, Value>

where Key: PartialEq, Value: PartialEq,

fn eq(&self, other: &KeyedVec<Key, Value>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Key, Value> Eq for KeyedVec<Key, Value>

where Key: Eq, Value: Eq,

impl<Key, Value> StructuralPartialEq for KeyedVec<Key, Value>