Trait iset::IndexType

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

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

    fn defined(self) -> bool { ... }
}

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

Implemented for u8, u16, u32, u64 and u128. DefaultIx is an alias for default index type (u32). IntervalMap or IntervalSet can store up to min(usize::MAX, Ix::MAX - 1) elements.

Using smaller index type saves memory usage and may reduce running time.

Associated Constants

const MAX: Self

Maximal possible value. Used for undefined indices.

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 (not equal to Self::MAX).

Implementations on Foreign Types

impl IndexType for u8

const MAX: Self

fn get(self) -> usize

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

impl IndexType for u16

const MAX: Self

fn get(self) -> usize

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

impl IndexType for u32

const MAX: Self

fn get(self) -> usize

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

impl IndexType for u64

const MAX: Self

fn get(self) -> usize

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

impl IndexType for u128

const MAX: Self

fn get(self) -> usize

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

Implementors