Struct Index

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

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§

Source§

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

Source

pub fn integer(&self) -> usize

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

Source§

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

Source

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

Return the index directly after.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'id, Array, M> Index<Index<'id>> for Container<'id, Array, M>
where Array: GetUnchecked,

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

Source§

type Output = <Array as Trustworthy>::Item

The returned type after indexing.
Source§

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

Performs the indexing (container[index]) operation. Read more
Source§

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

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

Source§

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

Performs the mutable indexing (container[index]) operation. Read more
Source§

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

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<'id, P, Q> PartialEq<Index<'id, Q>> for Index<'id, P>

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'id, P, Q> PartialOrd<Index<'id, Q>> for Index<'id, P>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
Source§

fn lt(&self, rhs: &Index<'id, Q>) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

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

Source§

type Proof = P

Source§

type WithoutProof = Index<'id, Unknown>

Source§

fn no_proof(self) -> Self::WithoutProof

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

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

Source§

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

Auto Trait Implementations§

§

impl<'id, Proof> Freeze for Index<'id, Proof>

§

impl<'id, Proof> RefUnwindSafe for Index<'id, Proof>
where Proof: RefUnwindSafe,

§

impl<'id, Proof> Send for Index<'id, Proof>
where Proof: Send,

§

impl<'id, Proof> Sync for Index<'id, Proof>
where Proof: Sync,

§

impl<'id, Proof> Unpin for Index<'id, Proof>
where Proof: Unpin,

§

impl<'id, Proof> UnwindSafe for Index<'id, Proof>
where Proof: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.