Struct gvec::GenerationalIndex

pub struct GenerationalIndex { /* fields omitted */ }

An index with a versioning scheme

The index for the GenerationalVec that has a so-called Generation scheme, akin to a versioning system, that coupled with the GenerationalVec struct, prevents invalid access to specific elements in the vector.

Methods

impl GenerationalIndex

pub fn new(index: usize, generation: usize) -> GenerationalIndex

pub fn index(&self) -> usize

pub fn generation(&self) -> usize

Trait Implementations

impl Clone for GenerationalIndex

fn clone(&self) -> GenerationalIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for GenerationalIndex

fn cmp(&self, other: &GenerationalIndex) -> 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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for GenerationalIndex

impl Copy for GenerationalIndex

impl PartialOrd<GenerationalIndex> for GenerationalIndex

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

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

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

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

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

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

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

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

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

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

impl PartialEq<GenerationalIndex> for GenerationalIndex

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

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

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

This method tests for !=.

impl Debug for GenerationalIndex

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

Formats the value using the given formatter.

impl<T> Index<GenerationalIndex> for DenseVec<T>

type Output = T

The returned type after indexing.

fn index(&self, index: GenerationalIndex) -> &Self::Output

Panics

Indexing will panic! when the generation of the given index does not match the generation in the vector. Use GenVec::get() instead as a non-panic version that will return an Option.