Trait IndexType

pub trait IndexType:
    Copy
    + Display
    + Sized
    + Eq
    + Ord {
    const MAX: Self;

    // Required methods
    fn get(self) -> usize;
    fn new(element_num: usize) -> Result<Self, &'static str>;

    // Provided method
    fn defined(self) -> bool { ... }
}

Trait for index types: used in the inner representation of IntervalMap and IntervalSet.

Implemented for u8, u16, u32 and u64, u32 is used by default (DefaultIx).

IntervalMap or IntervalSet can store up to Ix::MAX - 1 elements (for example IntervalMap<_, _, u8> can store up to 255 items).

Using smaller index types saves memory and slightly reduces running time.

Required Associated Constants

const MAX: Self

Undefined index. There can be no indices higher than MAX.

Required Methods

fn get(self) -> usize

Converts index into usize.

fn new(element_num: usize) -> Result<Self, &'static str>

Creates a new index. Returns error if the elemen_num is too big.

Provided Methods

fn defined(self) -> bool

Returns true if the index is defined.

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 IndexType for u8

const MAX: Self = 255u8

fn get(self) -> usize

fn new(element_num: usize) -> Result<Self, &'static str>

impl IndexType for u16

const MAX: Self = 65_535u16

fn get(self) -> usize

fn new(element_num: usize) -> Result<Self, &'static str>

impl IndexType for u32

const MAX: Self = 4_294_967_295u32

fn get(self) -> usize

fn new(element_num: usize) -> Result<Self, &'static str>

impl IndexType for u64

const MAX: Self = 18_446_744_073_709_551_615u64

fn get(self) -> usize

fn new(element_num: usize) -> Result<Self, &'static str>

Implementors