Struct pui_vec::Id

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

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>

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

Create a new Self

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

impl<T: Hash> Hash for Id<T>

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: Ord> Ord for Id<T>

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

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

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

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Id<T>> for Id<T>

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

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

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

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

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

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

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

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

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

This method 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.

pub 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.

pub 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.

pub 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.

pub 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.

pub 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.

pub 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

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

Is self contained in PuiVec

pub fn slice_index(&self) -> Self::SliceIndex

impl<T> StructuralEq for Id<T>

impl<T> StructuralPartialEq for Id<T>