Struct MaybeIdx

#[repr(transparent)]
pub struct MaybeIdx<'n, I>(Branded<'n, I>)
where
    I: Index;

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

Tuple Fields

0: Branded<'n, I>

Implementations

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

where I: Index,

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

Returns an index value.

pub fn none() -> MaybeIdx<'n, I>

Returns a None value.

pub fn new_checked(idx: <I as Index>::Signed, size: Size<'n>) -> MaybeIdx<'n, I>

Returns a constrained index value if idx is nonnegative, None otherwise.

pub unsafe fn new_unchecked( idx: <I as Index>::Signed, size: Size<'n>, ) -> MaybeIdx<'n, I>

Returns a constrained index value if idx is nonnegative, None otherwise.

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

Returns a constrained index value if idx is nonnegative, None otherwise.

pub fn into_inner(self) -> I

Returns the inner value.

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

Returns the index if available, or None otherwise.

pub fn zx(self) -> !

Unimplemented: Zero extend the value.

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

Sign extend the value.

pub fn from_slice_mut_checked<'a>( slice: &'a mut [<I as Index>::Signed], size: Size<'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 as Index>::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 as Index>::Signed], size: Size<'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 as Index>::Signed]

Convert a constrained slice to an unconstrained one.

pub unsafe fn from_slice_ref_unchecked<'a>( slice: &'a [<I as Index>::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 for MaybeIdx<'n, I>

where I: Clone + Index,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where I: Debug + Index,

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

Formats the value using the given formatter.

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

where I: Index,

type Target = <I as Index>::Signed

The resulting type after dereferencing.

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

Dereferences the value.

impl<'n, I> PartialEq for MaybeIdx<'n, I>

where I: PartialEq + Index,

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> Copy for MaybeIdx<'n, I>

where I: Copy + Index,

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

where I: Eq + Index,

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

where I: Index,