Struct Index

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

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

Implementations§

Source§

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

Source

pub fn untrusted(&self) -> I

This index without the branding.

Source

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

This index without the emptiness proof.

Trait Implementations§

Source§

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

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, I: Idx, Emptiness> Debug for Index<'id, I, Emptiness>

Source§

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

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

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

Source§

fn hash<H: Hasher>(&self, state: &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: TrustedContainer + ?Sized, I: Idx> Index<Index<'id, I>> for Container<'id, Array>

Source§

type Output = <Array as TrustedContainer>::Item

The returned type after indexing.
Source§

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

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

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

Source§

fn cmp(&self, other: &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, I: Idx, P, Q> PartialEq<Index<'id, I, Q>> for Index<'id, I, P>

Source§

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

Source§

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

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

fn lt(&self, other: &Rhs) -> 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, I: Idx, Emptiness> Copy for Index<'id, I, Emptiness>

Source§

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

Auto Trait Implementations§

§

impl<'id, I, Emptiness> Freeze for Index<'id, I, Emptiness>
where I: Freeze,

§

impl<'id, I, Emptiness> RefUnwindSafe for Index<'id, I, Emptiness>
where I: RefUnwindSafe, Emptiness: RefUnwindSafe,

§

impl<'id, I, Emptiness> Send for Index<'id, I, Emptiness>
where I: Send, Emptiness: Send,

§

impl<'id, I, Emptiness> Sync for Index<'id, I, Emptiness>
where I: Sync, Emptiness: Sync,

§

impl<'id, I, Emptiness> Unpin for Index<'id, I, Emptiness>
where I: Unpin, Emptiness: Unpin,

§

impl<'id, I = u32, Emptiness = NonEmpty> !UnwindSafe for Index<'id, I, Emptiness>

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, Array> TrustedItem<&Array> for T
where Array: TrustedContainer<Item = T> + ?Sized, T: TrustedItem<Array> + ?Sized,

Source§

type Unit = <T as TrustedItem<Array>>::Unit

Source§

fn vet<'id, I>( idx: I, container: &Container<'id, &Array>, ) -> Result<Index<'id, I, Unknown>, IndexError>
where I: Idx,

Vet an index for being on item boundaries. Read more
Source§

fn after<'id, I>( this: Index<'id, I>, container: &Container<'id, &Array>, ) -> Index<'id, I, Unknown>
where I: Idx,

Increment an index to the next item, potentially leaving the container.
Source§

fn advance<'id, I>( this: Index<'id, I>, container: &Container<'id, &Array>, ) -> Option<Index<'id, I>>
where I: Idx,

Advance an index to the next item, if a next item exists.
Source§

impl<T> TrustedItem<[T]> for T

Source§

type Unit = T

Source§

fn vet<'id, I>( idx: I, container: &Container<'id, [T]>, ) -> Result<Index<'id, I, Unknown>, IndexError>
where I: Idx,

Vet an index for being on item boundaries. Read more
Source§

fn after<'id, I>( this: Index<'id, I>, _: &Container<'id, [T]>, ) -> Index<'id, I, Unknown>
where I: Idx,

Increment an index to the next item, potentially leaving the container.
Source§

fn advance<'id, I>( this: Index<'id, I>, container: &Container<'id, [T]>, ) -> Option<Index<'id, I>>
where I: Idx,

Advance an index to the next item, if a next item exists.
Source§

impl<T, Array> TrustedItem<Box<Array>> for T
where Array: TrustedContainer<Item = T> + ?Sized, T: TrustedItem<Array> + ?Sized,

Source§

type Unit = <T as TrustedItem<Array>>::Unit

Source§

fn vet<'id, I>( idx: I, container: &Container<'id, Box<Array>>, ) -> Result<Index<'id, I, Unknown>, IndexError>
where I: Idx,

Vet an index for being on item boundaries. Read more
Source§

fn after<'id, I>( this: Index<'id, I>, container: &Container<'id, Box<Array>>, ) -> Index<'id, I, Unknown>
where I: Idx,

Increment an index to the next item, potentially leaving the container.
Source§

fn advance<'id, I>( this: Index<'id, I>, container: &Container<'id, Box<Array>>, ) -> Option<Index<'id, I>>
where I: Idx,

Advance an index to the next item, if a next item exists.
Source§

impl<T> TrustedItem<Vec<T>> for T
where T: TrustedItem<[T]>,

Source§

type Unit = <T as TrustedItem<[T]>>::Unit

Source§

fn vet<'id, I>( idx: I, container: &Container<'id, Vec<T>>, ) -> Result<Index<'id, I, Unknown>, IndexError>
where I: Idx,

Vet an index for being on item boundaries. Read more
Source§

fn after<'id, I>( this: Index<'id, I>, container: &Container<'id, Vec<T>>, ) -> Index<'id, I, Unknown>
where I: Idx,

Increment an index to the next item, potentially leaving the container.
Source§

fn advance<'id, I>( this: Index<'id, I>, container: &Container<'id, Vec<T>>, ) -> Option<Index<'id, I>>
where I: Idx,

Advance an index to the next item, if a next item exists.
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.