Struct id_vec::id::Id

pub struct Id<T> { /* fields omitted */ }

Used as a key to access an instance inside a IdVec. Internally, this is only an integer index (but with greater type safety).

Methods

impl<T> Id<T>

pub fn from_index(index: Index) -> Self

pub fn of<'s>(self, vec: &'s IdVec<T>) -> &'s T

Convenience function which allows writing the index first, and the IdVec afterwards. Example: the_selected_entity.of(entities) Panics when calling on an invalid id

pub fn of_mut<'s>(self, vec: &'s mut IdVec<T>) -> &'s mut T

Convenience function which allows writing the index first, and the IdVec afterwards. Example: the_selected_entity.of_mut(entities) Panics when calling on an invalid id

pub fn try_of<'s>(self, vec: &'s IdVec<T>) -> Option<&'s T>

Convenience function which allows writing the index first, and the IdVec afterwards. Example: the_selected_entity.try_of(entities)

pub fn try_of_mut<'s>(self, vec: &'s mut IdVec<T>) -> Option<&'s mut T>

Convenience function which allows writing the index first, and the IdVec afterwards. Example: the_selected_entity.try_of_mut(entities)

pub fn index_value(self) -> Index

The actual integer value for this Id.

Trait Implementations

impl<T> Index<Id<T>> for IdVec<T>

type Output = T

The returned type after indexing.

fn index(&self, element: Id<T>) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Id<T>> for IdVec<T>

fn index_mut(&mut self, element: Id<T>) -> &mut T

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

impl<T> Eq for Id<T>

impl<T> PartialEq for Id<T>

fn eq(&self, other: &Id<T>) -> bool

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

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

This method tests for !=.

impl<T> Copy for Id<T>

impl<T> Clone for Id<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Hash for Id<T>

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,

Feeds a slice of this type into the given [Hasher].

impl<T> Debug for Id<T>

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

Formats the value using the given formatter.