Struct indexing::Index

pub struct Index<'id, I: Idx = u32, Emptiness = NonEmpty> { /* fields omitted */ }

A branded index.

Index<'id> only indexes the container instantiated with the exact same lifetime for the parameter 'id created by the scope function.

The type parameter Emptiness determines if the index is followable. A NonEmpty index points to a valid element. An Unknown index is unknown, or it points to an edge index (one past the end).

Methods

impl<'id, I: Idx, Emptiness> Index<'id, I, Emptiness>

pub fn untrusted(&self) -> I

This index without the branding.

pub fn erased(&self) -> Index<'id, I, Unknown>

This index without the emptiness proof.

Trait Implementations

impl<'id, I: Idx, Emptiness> Copy for Index<'id, I, Emptiness>

impl<'id, I: Idx, Emptiness> Clone for Index<'id, I, Emptiness>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'id, I: Idx, Emptiness> Debug for Index<'id, I, Emptiness>

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

Formats the value using the given formatter.

impl<'id, I: Idx, P, Q> PartialEq<Index<'id, I, Q>> for Index<'id, I, P>

fn eq(&self, other: &Index<'id, I, Q>) -> bool

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

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'id, I: Idx, Emptiness> Eq for Index<'id, I, Emptiness>

impl<'id, I: Idx, Emptiness> Ord for Index<'id, I, Emptiness>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<'id, I: Idx, P, Q> PartialOrd<Index<'id, I, Q>> for Index<'id, I, P>

fn partial_cmp(&self, other: &Index<'id, I, Q>) -> Option<Ordering>

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

#[must_use]

fn lt(&self, other: &Rhs) -> bool

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

#[must_use]

fn le(&self, other: &Rhs) -> bool

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

#[must_use]

fn gt(&self, other: &Rhs) -> bool

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

#[must_use]

fn ge(&self, other: &Rhs) -> bool

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

impl<'id, Array: TrustedContainer + ?Sized, I: Idx> Index<Index<'id, I, NonEmpty>> for Container<'id, Array>

type Output = Array::Item

The returned type after indexing.

fn index(&self, index: Index<'id, I, NonEmpty>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'id, I: Idx, Emptiness> Hash for Index<'id, I, Emptiness>

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].