Struct NonZeroIndex

pub struct NonZeroIndex<T: NonZeroAble> { /* private fields */ }

An arena index which is always nonzero. Useful for Option size optimizations

Trait Implementations

impl<T> ArenaIndex for NonZeroIndex<T>

where T: NonZeroAble + FromPrimitive, NonZeroIndex<T>: Copy, <<T as NonZeroAble>::NonZero as NonZero>::Primitive: ToPrimitive,

fn from_idx(idx: usize) -> Self

Create an arena index from a usize

fn to_idx(self) -> usize

Transform an arena index into a usize

impl<T: Clone + NonZeroAble> Clone for NonZeroIndex<T>

where T::NonZero: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + NonZeroAble> Debug for NonZeroIndex<T>

where T::NonZero: Debug,

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

Formats the value using the given formatter.

impl<T: Hash + NonZeroAble> Hash for NonZeroIndex<T>

where T::NonZero: Hash,

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 + NonZeroAble> Ord for NonZeroIndex<T>

where T::NonZero: Ord,

fn cmp(&self, other: &NonZeroIndex<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 + NonZeroAble> PartialEq for NonZeroIndex<T>

where T::NonZero: PartialEq,

fn eq(&self, other: &NonZeroIndex<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 + NonZeroAble> PartialOrd for NonZeroIndex<T>

where T::NonZero: PartialOrd,

fn partial_cmp(&self, other: &NonZeroIndex<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: Copy + NonZeroAble> Copy for NonZeroIndex<T>

where T::NonZero: Copy,

impl<T: Eq + NonZeroAble> Eq for NonZeroIndex<T>

where T::NonZero: Eq,

impl<T: NonZeroAble> StructuralPartialEq for NonZeroIndex<T>