Struct IdxInclusive

pub struct IdxInclusive<'n, I>(/* private fields */);

I value smaller or equal to the size corresponding to the lifetime 'n.

Implementations

impl<'n> IdxInclusive<'n, usize>

pub fn range_to( self, last: Self, ) -> impl DoubleEndedIterator<Item = Idx<'n, usize>>

Returns an iterator over constrained indices from 0 to self (exclusive).

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

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

Returns a constrained inclusive index after checking that it’s bounded (inclusively) by size.

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

Returns a constrained inclusive index, assuming that it’s bounded (inclusively) by size.

pub unsafe fn new_raw_unchecked(idx: I) -> Self

Returns a constrained inclusive index, assuming that it’s bounded (inclusively) by the size tied to 'n.

pub fn into_inner(self) -> I

Returns the unconstrained value.

pub fn sx(self) -> !

Unimplemented: Sign extend the value.

pub fn zx(self) -> !

Unimplemented: Zero extend the value.

Trait Implementations

impl<'n, I: Clone> Clone for IdxInclusive<'n, I>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for IdxInclusive<'_, I>

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

Formats the value using the given formatter.

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

type Target = I

The resulting type after dereferencing.

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

Dereferences the value.

impl<'n, I: Ord> Ord for IdxInclusive<'n, I>

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

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

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

impl<'n, I: Eq> Eq for IdxInclusive<'n, I>

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