Struct v9::id::CheckedId

pub struct CheckedId<'a, M: TableMarker> { /* fields omitted */ }

An Id that is known to be in-bounds on the given table. You should check the Id if you'll be doing a lot of indexing.

Trait Implementations

impl<'a, M: TableMarker> Check for CheckedId<'a, M>

type M = M

fn to_usize(&self) -> usize

unsafe fn from_usize(i: usize) -> Self

unsafe fn step(self, d: i8) -> Self

fn to_raw(&self) -> <Self::M as TableMarker>::RawId

unsafe fn check_from_len<'a>(
    self,
    table: PhantomData<&'a Self::M>,
    max: usize
) -> CheckedId<'a, Self::M>

fn uncheck(&self) -> Id<Self::M>

impl<'a, M: TableMarker> Into<Id<M>> for CheckedId<'a, M>

fn into(self) -> Id<M>

Performs the conversion.

impl<'a, M: Clone + TableMarker> Clone for CheckedId<'a, M>

fn clone(&self) -> CheckedId<'a, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, M: Copy + TableMarker> Copy for CheckedId<'a, M>

impl<'a, M: TableMarker> Eq for CheckedId<'a, M>

impl<'a, M: TableMarker> Ord for CheckedId<'a, M>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a, M: TableMarker> PartialEq<CheckedId<'a, M>> for CheckedId<'a, M>

fn eq(&self, other: &Self) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, M: TableMarker> PartialOrd<CheckedId<'a, M>> for CheckedId<'a, M>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl<'a, M: TableMarker> Debug for CheckedId<'a, M>

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

Formats the value using the given formatter.