Struct hash_arr_map::Idx

pub struct Idx<T: ?Sized> { /* fields omitted */ }

A value represented as an index.

Valid indices

Valid indices are defined by the type T. In order for an index to be valid, they must be valid to be passed into FromIndex::from_index.

Created by either IntoIndex::into_index or Idx::try_new.

Implementations

impl<T: ?Sized + NewIndex> Idx<T>

pub fn try_new(v: NonZeroUsize) -> Option<Self>

Create a new index with the specified value if the type allows it.

impl<T: ?Sized> Idx<T>

pub const unsafe fn new(v: NonZeroUsize) -> Self

Create a new index with the specific value.

Safety

The value must be a valid index.

pub const unsafe fn from_usize(v: usize) -> Option<Self>

Same as Self::new, except that v can be zero, and None will be returned.

Safety

The value must either be a valid index or zero.

pub const fn get(&self) -> NonZeroUsize

pub const unsafe fn cast<U: ?Sized>(self) -> Idx<U>

This reinterprets the index as a different type of index; essentially Idx::<U>::new(self.get()).

Safety

The index must be a valid index for type U.

impl<T: ?Sized> Idx<T>

pub fn cast_safe<U: Borrow<T>>(self) -> Idx<U>

This reinterprets the index as a different type of index; essentially Idx::<U>::new(self.get()).

This is restricted by Borrow, meaning that it is type-safe.

impl<T: ?Sized + FromIndex> Idx<T>

pub fn into_value(self) -> T

Convert this index into a value.

A shorthand for <T as FromIndex>::from_index(self).

Trait Implementations

impl<T: ?Sized> Clone for Idx<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized> Debug for Idx<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Display for Idx<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + ?Sized> PartialEq<Idx<T>> for Idx<T>

fn eq(&self, other: &Idx<T>) -> bool

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

fn ne(&self, other: &Idx<T>) -> bool

This method tests for !=.

impl<T: Eq + ?Sized> Eq for Idx<T>

impl<T: ?Sized> StructuralEq for Idx<T>

impl<T: ?Sized> StructuralPartialEq for Idx<T>