Struct index_ext::tag::Idx

pub struct Idx<I, Tag> { /* fields omitted */ }

A valid index for all slices of the same length.

While this has a generic parameter, you can only instantiate this type for specific types through one of the constructors of a corresponding [Len] struct.

Implementations

impl<T, I> Idx<I, T>

pub fn into_inner(self) -> I

Get the inner index.

impl<T> Idx<usize, T>

#[must_use = "Returns a new index"]pub fn saturating_sub(self, sub: usize) -> Self

Create a smaller index.

#[must_use = "Returns a new index"]pub fn truncate(self, min: usize) -> Self

Bound the index from above.

#[must_use = "Returns a new index"]pub fn into_range(self) -> Idx<Range<usize>, T>

Return the range that contains this element.

#[must_use = "Returns a new index"]pub fn into_len(self) -> Len<T>

Get a length up-to, not including this index.

#[must_use = "Returns a new index"]pub fn into_end(self) -> NonZeroLen<T>

Get the length beyond this index.

Unlike turning it into a range and using its end, this guarantees that the end is non-zero as it knows the range not to be empty.

impl<T> Idx<RangeTo<usize>, T>

#[must_use = "Returns a new index"]pub fn into_end(self) -> Len<T>

Get a length up-to, not including this index.

#[must_use = "Returns a new index"]pub fn range_from(self, from: Len<T>) -> Option<Idx<Range<usize>, T>>

Construct an index starting at an element.

This method return Some when from does not exceed the end index.

impl<T> Idx<RangeFrom<usize>, T>

#[must_use = "Returns a new index"]pub fn into_start(self) -> Len<T>

Get a length up-to, not including this index.

#[must_use = "Returns a new index"]pub fn range_to(self, to: Len<T>) -> Option<Idx<Range<usize>, T>>

Construct an index up to at an element.

This method return Some when to does not exceed the end index.

impl<T> Idx<Range<usize>, T>

#[must_use = "Returns a new index"]pub fn into_start(self) -> Len<T>

Get a length up-to, not including this index.

#[must_use = "Returns a new index"]pub fn into_end(self) -> Len<T>

Get a length up-to, not including this index.

Trait Implementations

impl<I: Clone, Tag: Clone> Clone for Idx<I, Tag>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Copy, Tag: Copy> Copy for Idx<I, Tag>

impl<T: Tag, E, I, '_> Index<Idx<I, T>> for Ref<'_, E, T> where
    I: SliceIndex<[E]>, 

type Output = I::Output

The returned type after indexing.

fn index(&self, idx: Idx<I, T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: Tag, E, I, '_> Index<Idx<I, T>> for Mut<'_, E, T> where
    I: SliceIndex<[E]>, 

type Output = I::Output

The returned type after indexing.

fn index(&self, idx: Idx<I, T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: Tag, E, I, '_> IndexMut<Idx<I, T>> for Mut<'_, E, T> where
    I: SliceIndex<[E]>, 

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

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