Struct IndexWrap 

pub struct IndexWrap { /* private fields */ }

Wraps an index with negative indexing support.

Implementations

impl IndexWrap

pub fn index() -> Self

Get an instance for wrapping negative indices.

pub fn dim() -> Self

Get an instance for wrapping negative dimensions.

pub fn with_wrap_scalar(self, wrap_scalar: bool) -> Self

Set the policy for wrapping 0-size ranges.

When size == 0:

• if wrap_scalar; then size == 1
• otherwise; an error.

pub fn try_wrap<I: AsIndex>( &self, idx: I, size: usize, ) -> Result<usize, BoundsError>

Wrap an index with negative indexing support.

pub fn expect_wrap<I: AsIndex>(&self, idx: I, size: usize) -> usize

Wrap an index with negative indexing support.

pub fn expect_elem<I: AsIndex>(idx: I, size: usize) -> usize

Short-form [NegativeWrap::index().expect_wrap(idx, size)].

pub fn expect_dim<I: AsIndex>(idx: I, size: usize) -> usize

Short-form [NegativeWrap::dim().expect_wrap(idx, size)].

Trait Implementations

impl Debug for IndexWrap

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

Formats the value using the given formatter.