Struct indexing::Index

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

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 indices() constructor.

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

Methods

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

fn integer(&self) -> usize

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

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

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

Return the index directly after.

Trait Implementations

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, Q> PartialEq<Index<'id, Q>> for Index<'id, P>

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

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

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

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

This method tests for !=.

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, Proof: Eq> Eq for Index<'id, Proof>

impl<'id, Proof: PartialOrd> PartialOrd for Index<'id, Proof>

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

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

fn lt(&self, __arg_0: &Index<'id, Proof>) -> bool

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

fn le(&self, __arg_0: &Index<'id, Proof>) -> bool

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

fn gt(&self, __arg_0: &Index<'id, Proof>) -> bool

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

fn ge(&self, __arg_0: &Index<'id, Proof>) -> bool

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

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

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.