Struct idmap::table::TableIndex

pub struct TableIndex(_);

The index of an entry in either IdTable or EntryTable.

The marker index TableIndex::INVALID is used to indicate missing entries.

Implementations

impl TableIndex

pub const INVALID: TableIndex

The special marker index for a missing/invalid entry, which may be used by a table to indicate that an entry is missing.

This is used instead of an Option for performance reasons, as it can often be internally folded into a bounds check which would otherwise need a seperate check.

pub fn from_key<T: IntegerId>(key: &T) -> Self

Create a table index corresponding to the specified key

pub fn from_index(index: usize) -> Self

Create a table index from the specified value

pub fn index(self) -> Option<u32>

Give the underlying value of this index, or None if it’s invalid.

pub fn unwrap_index(self) -> u32

Unwrap the underlying value of this index, without checking validity in release builds.

This is completely safe to make this a debug-check since it’s already going to be bounds checked.

pub fn offset(self, amount: u32) -> Self

Add the specified value to this index, panicking on overflow

pub fn raw_index(self) -> u32

Give the internal value of this index, even if it’s invalid.

pub fn is_valid(self) -> bool

Check if the index is valid and not equal to TableIndex::INVALID

Trait Implementations

impl Clone for TableIndex

fn clone(&self) -> TableIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableIndex

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

Formats the value using the given formatter.

impl Ord for TableIndex

fn cmp(&self, other: &TableIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TableIndex> for TableIndex

fn eq(&self, other: &TableIndex) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TableIndex) -> bool

This method tests for !=.

impl PartialOrd<TableIndex> for TableIndex

fn partial_cmp(&self, other: &TableIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for TableIndex

impl Eq for TableIndex

impl StructuralEq for TableIndex

impl StructuralPartialEq for TableIndex