Struct Idx

#[repr(transparent)]
pub struct Idx<'n, I>(Branded<'n, I>);

I value smaller than the size corresponding to the lifetime 'n.

Tuple Fields

0: Branded<'n, I>

Implementations

impl<'n> Idx<'n, usize>

pub fn truncate<I>(self) -> Idx<'n, I>

where I: Index,

Truncate self to a smaller type I.

impl<'n, I> Idx<'n, I>

where I: Index,

pub fn new_checked(idx: I, size: Size<'n>) -> Idx<'n, I>

Returns a new index after asserting that it’s bounded by size.

pub unsafe fn new_unchecked(idx: I, size: Size<'n>) -> Idx<'n, I>

Returns a new index without asserting that it’s bounded by size.

pub unsafe fn new_raw_unchecked(idx: I) -> Idx<'n, I>

Returns a new index without asserting that it’s bounded by the value tied to the lifetime 'n.

pub fn into_inner(self) -> I

Returns the unconstrained value.

pub fn zx(self) -> Idx<'n, usize>

Zero extend the value.

pub fn sx(self) -> !

Unimplemented: Sign extend the value.

pub fn to_inclusive(self) -> IdxInclusive<'n, I>

Returns the index, bounded inclusively by the value tied to 'n.

pub fn next(self) -> IdxInclusive<'n, I>

Returns the next index, bounded inclusively by the value tied to 'n.

pub fn from_slice_mut_checked<'a>( slice: &'a mut [I], size: Size<'n>, ) -> &'a mut [Idx<'n, I>]

Assert that the values of slice are all bounded by size.

pub unsafe fn from_slice_mut_unchecked<'a>( slice: &'a mut [I], ) -> &'a mut [Idx<'n, I>]

Assume that the values of slice are all bounded by the value tied to 'n.

pub fn from_slice_ref_checked<'a>( slice: &'a [I], size: Size<'n>, ) -> &'a [Idx<'n, I>]

Assert that the values of slice are all bounded by size.

pub unsafe fn from_slice_ref_unchecked<'a>(slice: &'a [I]) -> &'a [Idx<'n, I>]

Assume that the values of slice are all bounded by the value tied to 'n.

Trait Implementations

impl<'n, I> Clone for Idx<'n, I>

where I: Clone,

fn clone(&self) -> Idx<'n, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Debug for Idx<'_, I>

where I: Debug,

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

Formats the value using the given formatter.

impl<I> Deref for Idx<'_, I>

type Target = I

The resulting type after dereferencing.

fn deref(&self) -> &<Idx<'_, I> as Deref>::Target

Dereferences the value.

impl<'n, T> Index<Idx<'n, usize>> for Array<'n, T>

type Output = T

The returned type after indexing.

fn index( &self, idx: Idx<'n, usize>, ) -> &<Array<'n, T> as Index<Idx<'n, usize>>>::Output

Performs the indexing (container[index]) operation.

impl<'n, T> IndexMut<Idx<'n, usize>> for Array<'n, T>

fn index_mut( &mut self, idx: Idx<'n, usize>, ) -> &mut <Array<'n, T> as Index<Idx<'n, usize>>>::Output

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

impl<'n, I> Ord for Idx<'n, I>

where I: Ord,

fn cmp(&self, other: &Idx<'n, I>) -> 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<'n, I> PartialEq for Idx<'n, I>

where I: PartialEq,

fn eq(&self, other: &Idx<'n, I>) -> 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<'n, I> PartialOrd for Idx<'n, I>

where I: PartialOrd,

fn partial_cmp(&self, other: &Idx<'n, I>) -> 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<'n, I> Copy for Idx<'n, I>

where I: Copy,

impl<'n, I> Eq for Idx<'n, I>

where I: Eq,

impl<'n, I> StructuralPartialEq for Idx<'n, I>