Trait Index

pub trait Index:
    Copy
    + Clone
    + Debug
    + Display
    + Into<usize>
    + PartialEq
    + Eq
    + PartialOrd
    + Ord
    + Send
    + Sync
    + Sized
    + 'static {
    const ZERO: Self;
    const MAX_USIZE: usize;

    // Required methods
    fn from_usize(val: usize) -> Self;
    fn try_from_usize(val: usize) -> Option<Self>;
    fn saturating_add(self, val: usize) -> Self;
    fn saturating_sub(self, val: usize) -> Self;
    fn saturating_mul(self, val: usize) -> Self;

    // Provided method
    fn to_usize(self) -> usize { ... }
}

Types which may be used to index and define the length and capacity of collections.

Required Associated Constants

const ZERO: Self

The zero value

const MAX_USIZE: usize

The maximum representable value of this type as a usize

Required Methods

fn from_usize(val: usize) -> Self

Create an instance of this type from a usize, panicking if the bounds are exceeded

fn try_from_usize(val: usize) -> Option<Self>

Try to create an instance of this type from a usize

fn saturating_add(self, val: usize) -> Self

Add a usize without exceeding the bounds of this type

fn saturating_sub(self, val: usize) -> Self

Subtract a usize without exceeding the bounds of this type

fn saturating_mul(self, val: usize) -> Self

Multiply by a usize without exceeding the bounds of this type

Provided Methods

fn to_usize(self) -> usize

Convert this instance into a usize

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Index for u8

const ZERO: Self = 0u8

const MAX_USIZE: usize = 255usize

fn from_usize(val: usize) -> Self

fn try_from_usize(val: usize) -> Option<Self>

fn to_usize(self) -> usize

fn saturating_add(self, val: usize) -> Self

fn saturating_sub(self, val: usize) -> Self

fn saturating_mul(self, val: usize) -> Self

impl Index for usize

const ZERO: Self = 0usize

const MAX_USIZE: usize = 4_294_967_295usize

fn from_usize(val: usize) -> Self

fn try_from_usize(val: usize) -> Option<Self>

fn saturating_add(self, val: usize) -> Self

fn saturating_sub(self, val: usize) -> Self

fn saturating_mul(self, val: usize) -> Self

Implementors