Struct Key 

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

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: OneShotIdentifier, V: Version> ArenaKey<I, V> for Key<Id<I::Token>, V::Save>

Available on crate feature pui only.

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

fn index(&self) -> usize

The index of this key

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

The version of this key

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

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

fn index(&self) -> usize

The index of this key

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

The version of this key

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

fn index(&self) -> usize

The index of this key

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

The version of this key

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<'scope, V> AsMut<Key<Id<ScopedToken<'scope>>, V>> for ScopedKey<'scope, V>

Available on crate feature scoped only.

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

Converts this type into a mutable reference of the (usually inferred) input type.

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

Available on crate feature scoped only.

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

Converts this type into a mutable reference of the (usually inferred) input type.

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

Available on crate feature scoped only.

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

Converts this type into a shared reference of the (usually inferred) input type.

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

Available on crate feature scoped only.

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

Converts this type into a shared reference of the (usually inferred) input type.

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

Available on crate feature scoped only.

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>

Available on crate feature scoped only.

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>

Available on crate feature scoped only.

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>

Available on crate feature scoped only.

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

Mutably borrows from an owned value.

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

Available on crate feature pui only.

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, V: Version> BuildArenaKey<I, V> for Key<usize, V::Save>

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>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

Available on crate feature scoped only.

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

Converts to this type from the input type.

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

Available on crate feature scoped only.

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

Converts to this type from the input type.

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

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

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<T> Index<Key<usize>> for SlotMap<T>

Available on crate feature slotmap only.

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

Available on crate feature slotmap only.

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

Available on crate feature slotmap only.

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

Available on crate feature slotmap only.

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

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

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

Available on crate feature slotmap only.

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

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

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

Available on crate feature slotmap only.

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>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

fn eq(&self, other: &Key<Id, V>) -> 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<Id: PartialOrd, V: PartialOrd> PartialOrd for Key<Id, V>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

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

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

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