Struct pui_arena::Key

pub struct Key<Id, V = SavedDefaultVersion> { /* fields omitted */ }

A key into a sparse arena

Implementations

impl<Id, V> Key<Id, V>

pub const fn new(id: Id, version: V) -> Self

Create a new key from an id and version

pub const fn id(&self) -> &Id

The id the given key

pub const fn version(&self) -> &V

The version of the given key

Trait Implementations

impl<I, V: Version> ArenaKey<I, V> for Key<usize, V::Save>

pub fn index(&self) -> usize

The index of this key

pub fn version(&self) -> Option<V::Save>

The version of this key

pub fn validate_ident<'a>(
    &self,
    ident: &'a I,
    validator: Validator<'a>
) -> CompleteValidator<'a>

An optimization that allows you to construct an unchecked index into the Arena

impl<I: OneShotIdentifier, V: Version> ArenaKey<I, V> for Key<Id<I::Token>, V::Save>

pub fn validate_ident<'a>(
    &self,
    ident: &'a I,
    validator: Validator<'a>
) -> CompleteValidator<'a>

An optimization that allows you to construct an unchecked index into the Arena

pub fn index(&self) -> usize

The index of this key

pub fn version(&self) -> Option<V::Save>

The version of this key

impl<I, V: Version> ArenaKey<I, V> for Key<TrustedIndex, V::Save>

pub fn validate_ident<'a>(
    &self,
    ident: &'a I,
    validator: Validator<'a>
) -> CompleteValidator<'a>

An optimization that allows you to construct an unchecked index into the Arena

pub fn index(&self) -> usize

The index of this key

pub fn version(&self) -> Option<V::Save>

The version of this key

impl<'scope, V> AsMut<Key<Id<ScopedToken<'scope>>, V>> for ScopedKey<'scope, V>

pub fn as_mut(&mut self) -> &mut Key<Id<ScopedToken<'scope>>, V>

Performs the conversion.

impl<'scope, V> AsMut<ScopedKey<'scope, V>> for Key<Id<ScopedToken<'scope>>, V>

pub fn as_mut(&mut self) -> &mut ScopedKey<'scope, V>

Performs the conversion.

impl<'scope, V> AsRef<Key<Id<ScopedToken<'scope>>, V>> for ScopedKey<'scope, V>

pub fn as_ref(&self) -> &Key<Id<ScopedToken<'scope>>, V>

Performs the conversion.

impl<'scope, V> AsRef<ScopedKey<'scope, V>> for Key<Id<ScopedToken<'scope>>, V>

pub fn as_ref(&self) -> &ScopedKey<'scope, V>

Performs the conversion.

impl<'scope, V> Borrow<Key<Id<ScopedToken<'scope>>, V>> for ScopedKey<'scope, V>

pub fn borrow(&self) -> &Key<Id<ScopedToken<'scope>>, V>

Immutably borrows from an owned value.

impl<'scope, V> Borrow<ScopedKey<'scope, V>> for Key<Id<ScopedToken<'scope>>, V>

pub fn borrow(&self) -> &ScopedKey<'scope, V>

Immutably borrows from an owned value.

impl<'scope, V> BorrowMut<Key<Id<ScopedToken<'scope>>, V>> for ScopedKey<'scope, V>

pub fn borrow_mut(&mut self) -> &mut Key<Id<ScopedToken<'scope>>, V>

Mutably borrows from an owned value.

impl<'scope, V> BorrowMut<ScopedKey<'scope, V>> for Key<Id<ScopedToken<'scope>>, V>

pub fn borrow_mut(&mut self) -> &mut ScopedKey<'scope, V>

Mutably borrows from an owned value.

impl<I, V: Version> BuildArenaKey<I, V> for Key<usize, V::Save>

pub unsafe fn new_unchecked(index: usize, save: V::Save, ident: &I) -> Self

Create a new arena key given an index, version save, and identifier

impl<I: OneShotIdentifier, V: Version> BuildArenaKey<I, V> for Key<Id<I::Token>, V::Save>

pub unsafe fn new_unchecked(index: usize, save: V::Save, ident: &I) -> Self

Create a new arena key given an index, version save, and identifier

impl<Id: Clone, V: Clone> Clone for Key<Id, V>

pub fn clone(&self) -> Key<Id, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Id: Copy, V: Copy> Copy for Key<Id, V>

impl<Id: Debug, V: Debug> Debug for Key<Id, V>

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

Formats the value using the given formatter.

impl<Id: Eq, V: Eq> Eq for Key<Id, V>

impl<'scope, V> From<Key<Id<ScopedToken<'scope>>, V>> for ScopedKey<'scope, V>

pub fn from(key: Key<Id<ScopedToken<'scope>>, V>) -> Self

Performs the conversion.

impl<'scope, V> From<ScopedKey<'scope, V>> for Key<Id<ScopedToken<'scope>>, V>

pub fn from(ScopedKey(key): ScopedKey<'scope, V>) -> Self

Performs the conversion.

impl<Id: Hash, V: Hash> Hash for Key<Id, V>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T> Index<Key<usize, SavedDefaultVersion>> for SlotMap<T>

type Output = T

The returned type after indexing.

pub fn index(&self, key: Key) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<Key<usize, SavedDefaultVersion>> for SlotMap<T>

type Output = T

The returned type after indexing.

pub fn index(&self, key: Key) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<Key<usize, SavedDefaultVersion>> for SlotMap<T>

type Output = T

The returned type after indexing.

pub fn index(&self, key: Key) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Key<usize, SavedDefaultVersion>> for SlotMap<T>

pub fn index_mut(&mut self, key: Key) -> &mut Self::Output

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

impl<T> IndexMut<Key<usize, SavedDefaultVersion>> for SlotMap<T>

pub fn index_mut(&mut self, key: Key) -> &mut Self::Output

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

impl<T> IndexMut<Key<usize, SavedDefaultVersion>> for SlotMap<T>

pub fn index_mut(&mut self, key: Key) -> &mut Self::Output

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

impl<Id: Ord, V: Ord> Ord for Key<Id, V>

pub fn cmp(&self, other: &Key<Id, V>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<Id: PartialEq, V: PartialEq> PartialEq<Key<Id, V>> for Key<Id, V>

pub fn eq(&self, other: &Key<Id, V>) -> bool

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

pub fn ne(&self, other: &Key<Id, V>) -> bool

This method tests for !=.

impl<Id: PartialOrd, V: PartialOrd> PartialOrd<Key<Id, V>> for Key<Id, V>

pub fn partial_cmp(&self, other: &Key<Id, V>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Key<Id, V>) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Key<Id, V>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Key<Id, V>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Key<Id, V>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Id, V> StructuralEq for Key<Id, V>

impl<Id, V> StructuralPartialEq for Key<Id, V>