Struct Idx 

pub struct Idx<'n, I: Index = usize> { /* private fields */ }

lifetime branded index.

safety

the type’s safety invariant is that all instances of this type are valid indices for Dim<'n> and less than or equal to i::signed::max.

Implementations

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

pub const unsafe fn new_unbound(idx: I) -> Self

create new branded value with an arbitrary brand.

safety

see struct safety invariant.

pub unsafe fn new_unchecked(idx: I, dim: Dim<'n>) -> Self

create new branded value with the same brand as Dim.

safety

the behavior is undefined unless idx < dim and idx <= i::signed::max.

pub fn new_checked(idx: I, dim: Dim<'n>) -> Self

create new branded value with the same brand as Dim.

panics

panics unless idx < dim and idx <= i::signed::max.

pub const fn unbound(self) -> I

returns the unconstrained value.

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

zero-extends the internal value into a usize.

impl<'n> Idx<'n>

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

truncate self to a smaller type i.

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

pub const fn to_incl(self) -> IdxInc<'n, I>

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

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

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

pub fn excl(self) -> IdxInc<'n, I>

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

pub fn from_slice_mut_checked<'a>( slice: &'a mut [I], size: Dim<'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: Dim<'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 + Index> Clone for Idx<'n, I>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

type Target = I

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'n, I: Index> From<Idx<'n, I>> for IdxInc<'n, I>

fn from(value: Idx<'n, I>) -> Self

Converts to this type from the input type.

impl<'n, I: Index> From<Idx<'n, I>> for MaybeIdx<'n, I>

fn from(value: Idx<'n, I>) -> Self

Converts to this type from the input type.

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

type Output = T

The returned type after indexing.

fn index(&self, idx: Idx<'n>) -> &Self::Output

Performs the indexing (container[index]) operation.

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

fn index_mut(&mut self, idx: Idx<'n>) -> &mut Self::Output

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

impl<'n, I: Ord + Index> Ord for Idx<'n, I>

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: Index> PartialEq<Dim<'n>> for Idx<'n, I>

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

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: Index> PartialOrd<Dim<'n>> for Idx<'n, I>

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

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<I: Index> Unbind<I> for Idx<'_, I>

unsafe fn new_unbound(idx: I) -> Self

creates new value

fn unbound(self) -> I

returns the unbound value, unconstrained by safety invariants

impl<'n, I: Copy + Index> Copy for Idx<'n, I>

impl<'n, I: Eq + Index> Eq for Idx<'n, I>

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