Struct MaybeIdx 

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

i value smaller than the size corresponding to the lifetime 'n, or none.

Implementations

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

pub fn from_index(idx: Idx<'n, I>) -> Self

returns an index value.

pub fn none() -> Self

returns a none value.

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

returns a constrained index value if idx is nonnegative, none otherwise.

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

returns a constrained index value if idx is nonnegative, none otherwise.

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

returns a constrained index value if idx is nonnegative, none otherwise.

pub fn unbound(self) -> I

returns the inner value.

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

returns the index if available, or none otherwise.

pub fn sx(self) -> MaybeIdx<'n>

sign extend the value.

pub fn from_slice_mut_checked<'a>( slice: &'a mut [I::Signed], size: Dim<'n>, ) -> &'a mut [MaybeIdx<'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::Signed], ) -> &'a mut [MaybeIdx<'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::Signed], size: Dim<'n>, ) -> &'a [MaybeIdx<'n, I>]

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

pub fn as_slice_ref<'a>(slice: &'a [MaybeIdx<'n, I>]) -> &'a [I::Signed]

convert a constrained slice to an unconstrained one.

pub unsafe fn from_slice_ref_unchecked<'a>( slice: &'a [I::Signed], ) -> &'a [MaybeIdx<'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 MaybeIdx<'n, I>

fn clone(&self) -> MaybeIdx<'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 MaybeIdx<'_, I>

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

Formats the value using the given formatter.

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

type Target = <I as Index>::Signed

The resulting type after dereferencing.

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

Dereferences the value.

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, I: Ord + Index> Ord for MaybeIdx<'n, I>

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

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

fn partial_cmp(&self, other: &MaybeIdx<'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 as Index>::Signed> for MaybeIdx<'_, I>

unsafe fn new_unbound(idx: I::Signed) -> Self

creates new value

fn unbound(self) -> I::Signed

returns the unbound value, unconstrained by safety invariants

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

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

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