Struct GenIndex

pub struct GenIndex<T> { /* private fields */ }

A simple generational index implementation. The data is stored in a read-only manner, Use RefCell to get mutability. Not secure, no index validity check.

Implementations

impl<T> GenIndex<T>

pub fn new() -> GenIndex<T>

Create an empty GenIndex

pub fn clear(&mut self)

Clear the GenIndex

pub fn contains(&self, index: &GenKey) -> bool

Check if a key is in the collection

pub fn get(&self, index: &GenKey) -> Result<&T, AutoDiffError>

Return the registered item

pub fn get_mut(&mut self, index: &GenKey) -> Option<&mut T>

Return a mut reference.

pub fn len(&self) -> usize

Number of item in the list.

pub fn is_empty(&self) -> bool

pub fn insert(&mut self, val: T) -> GenKey

Add a new item to the list.

pub fn remove(&mut self, index: &GenKey) -> Result<(), AutoDiffError>

Remove an item from the list.

pub fn replace(&mut self, index: &GenKey, val: T) -> Result<(), AutoDiffError>

Replace the item of the index with a new one.

pub fn iter_key(&self) -> GenIndexIter<'_, T>

Trait Implementations

impl<T: Clone> Clone for GenIndex<T>

fn clone(&self) -> GenIndex<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for GenIndex<T>

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

Formats the value using the given formatter.

impl<T> Default for GenIndex<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for GenIndex<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for GenIndex<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for GenIndex<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for GenIndex<T>