Struct Index

pub struct Index<'id, Proof = NonEmpty> { /* private fields */ }

A branded index.

Index<'id> only indexes the container instantiated with the exact same particular lifetime for the parameter 'id at its inception from the scope() function.

The type parameter Proof determines if the index is dereferenceable.

A NonEmpty index points to a valid element. An Unknown index is unknown, or it points to an edge index (just past the end).

Implementations

impl<'id, P> Index<'id, P>

pub fn integer(&self) -> usize

Return the index as an integer offset from the start of the container

impl<'id> Index<'id, NonEmpty>

pub fn after(self) -> Index<'id, Unknown>

Return the index directly after.

Trait Implementations

impl<'id, P> Clone for Index<'id, P>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'id, P> Debug for Index<'id, P>

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

Formats the value using the given formatter.

impl<'id, P> Hash for Index<'id, P>

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'id, Array, M> Index<Index<'id>> for Container<'id, Array, M>

where Array: GetUnchecked,

&self[i] where i is an Index<'id>.

type Output = <Array as Trustworthy>::Item

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'id, Array, M> IndexMut<Index<'id>> for Container<'id, Array, M>

where Array: GetUncheckedMut,

&mut self[i] where i is an Index<'id>.

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

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

impl<'id, P> Ord for Index<'id, P>

fn cmp(&self, rhs: &Self) -> 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<'id, P, Q> PartialEq<Index<'id, Q>> for Index<'id, P>

Index can only be compared with other indices of the same branding

fn eq(&self, rhs: &Index<'id, Q>) -> 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<'id, P, Q> PartialOrd<Index<'id, Q>> for Index<'id, P>

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

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

fn lt(&self, rhs: &Index<'id, Q>) -> 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<'id, P> Provable for Index<'id, P>

type Proof = P

type WithoutProof = Index<'id, Unknown>

fn no_proof(self) -> Self::WithoutProof

Return a copy of self with the proof parameter set to Unknown.

impl<'id, P> Copy for Index<'id, P>

impl<'id, P> Eq for Index<'id, P>