Struct unchecked_index::UncheckedIndex

pub struct UncheckedIndex<S>(_);

Wrapper type for unchecked indexing through the regular index syntax

Note that the indexing is checked with debug assertions, but unchecked in release mode. Test your code responsibly.

Trait Implementations

impl<S: Copy> Clone for UncheckedIndex<S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Copy> Copy for UncheckedIndex<S>

impl<T> Deref for UncheckedIndex<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for UncheckedIndex<T>

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

Mutably dereferences the value.

impl<T, I> Index<I> for UncheckedIndex<T> where
    T: GetUnchecked<I>, 

type Output = T::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Access the element(s) at index, without bounds checks!

Note: Will use debug assertions to check that the index is actually valid. In release mode, debug assertions are off by default.

Safety

The caller must ensure that index is always in bounds of the underlying container.

impl<T, I> IndexMut<I> for UncheckedIndex<T> where
    T: GetUncheckedMut<I>, 

fn index_mut(&mut self, index: I) -> &mut Self::Output

Access the element(s) at index, without bounds checks!

Note: Will use debug assertions to check that the index is actually valid. In release mode, debug assertions are off by default.

Safety

The caller must ensure that index is always in bounds of the underlying container.