Struct Id 

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

Available on crate feature pui only.

A branded index that can be used to elide bounds checks

Implementations

impl<T> Id<T>

pub const unsafe fn new_unchecked(index: usize, token: T) -> Self

Create a new branded index

Safety

The given index must be in bounds for the PuiVec whose identifier owns the given token

pub fn into_raw_parts(self) -> (usize, T)

Get the index and token from the branded index

pub const fn get(&self) -> usize

Returns the index of this Id

pub const fn token(&self) -> &T

Returns a reference to the token of this Id

Trait Implementations

impl<I: OneShotIdentifier> BuildPuiVecIndex<I> for Id<I::Token>

unsafe fn new_unchecked(slice_index: Self::SliceIndex, ident: &I) -> Self

Create a new Self

impl<T: Clone> Clone for Id<T>

fn clone(&self) -> Id<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Id<T>

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

Formats the value using the given formatter.

impl<T: Hash> 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Id<T>

fn cmp(&self, other: &Id<T>) -> 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<T: PartialEq> PartialEq for Id<T>

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

fn partial_cmp(&self, other: &Id<T>) -> 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<T, I: OneShotIdentifier> PuiVecAccess<T, I> for Id<I::Token>

type Output = T

The output type returned by methods.

unsafe fn get_unchecked<'a>(&self, vec: &'a PuiVec<T, I>) -> &'a Self::Output

Returns a shared reference to the output at this location, without performing any bounds checking. Calling this method with an out-of-boundsindex or a dangling slice pointer is undefined behavior even if the resulting reference is not used.

unsafe fn get_unchecked_mut<'a>( &self, vec: &'a mut PuiVec<T, I>, ) -> &'a mut Self::Output

Returns a uniquue reference to the output at this location, without performing any bounds checking. Calling this method with an out-of-boundsindex or a dangling slice pointer is undefined behavior even if the resulting reference is not used.

fn get<'a>(&self, vec: &'a PuiVec<T, I>) -> Option<&'a Self::Output>

Returns a shared reference to the output at this location, if in bounds.

fn get_mut<'a>(&self, vec: &'a mut PuiVec<T, I>) -> Option<&'a mut Self::Output>

Returns a unique reference to the output at this location, if in bounds.

fn index<'a>(&self, vec: &'a PuiVec<T, I>) -> &'a Self::Output

Returns a shared reference to the output at this location, panicking if out of bounds.

fn index_mut<'a>(&self, vec: &'a mut PuiVec<T, I>) -> &'a mut Self::Output

Returns a unique reference to the output at this location, panicking if out of bounds.

impl<I: OneShotIdentifier> PuiVecIndex<I> for Id<I::Token>

type SliceIndex = usize

The underlying index/range type

fn contained_in<T>(&self, vec: &PuiVec<T, I>) -> bool

Is self contained in PuiVec

impl<T: Copy> Copy for Id<T>

impl<T: Eq> Eq for Id<T>

impl<T> StructuralPartialEq for Id<T>