Struct index_ext::int::TryIndex

#[repr(transparent)]pub struct TryIndex<T>(pub T);

An indexing adaptor for TryInto.

This transparent wrapper allows any type to function as an index as long as it is fallibly convertible to a usize. Contrary to the simple integer types, the implementation of get_unchecked methods will not unsafely assume that the conversion itself can't fail, only that the resulting index is in-bounds.

Separating this from the main IndexType solves a coherence problem that would occurs when instantiating it with ranges: The standard library is permitted to add new impls of TryInto<usize>, for example even for Range<usize>. Hence, these two impls would overlap but we would like the first to have another return type than the second. The indirection over this type means that our impls are only generic for TryIndex<T> instead and do not overlap.

Trait Implementations

impl<T: Clone> Clone for TryIndex<T>

fn clone(&self) -> TryIndex<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for TryIndex<T>

impl<T: Debug> Debug for TryIndex<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for TryIndex<T>

fn default() -> TryIndex<T>

Returns the "default value" for a type.

impl<T: Eq> Eq for TryIndex<T>

impl<T: Hash> Hash for TryIndex<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T, U> Index<TryIndex<T>> for [U] where
    T: TryInto<usize> + IndexSealed,
    T::Error: Into<TryFromIntError>, 

type Output = U

The returned type after indexing.

fn index(&self, idx: TryIndex<T>) -> &U

Performs the indexing (container[index]) operation.

impl<T, U> IndexMut<TryIndex<T>> for [U] where
    T: TryInto<usize> + IndexSealed,
    T::Error: Into<TryFromIntError>, 

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

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

impl<T, U> IntSliceIndex<[U]> for TryIndex<T> where
    T: TryInto<usize>,
    T::Error: Into<TryFromIntError>, 

impl<T: Ord> Ord for TryIndex<T>

fn cmp(&self, other: &TryIndex<T>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<TryIndex<T>> for TryIndex<T>

fn eq(&self, other: &TryIndex<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TryIndex<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<TryIndex<T>> for TryIndex<T>

fn partial_cmp(&self, other: &TryIndex<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &TryIndex<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &TryIndex<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &TryIndex<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &TryIndex<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> StructuralEq for TryIndex<T>

impl<T> StructuralPartialEq for TryIndex<T>