Struct indexical::IndexedDomain

pub struct IndexedDomain<T: IndexedValue> { /* private fields */ }

An indexed collection of objects, implemented with an IndexVec.

Contains a reverse-mapping from T to T::Index for efficient lookups of indices.

Implementations

impl<T: IndexedValue> IndexedDomain<T>

pub fn new(domain: IndexVec<T::Index, T>) -> Self

Creates a new domain from an indexed vector.

Consider using the FromIterator implementation if you don’t want to manually construct an IndexVec object.

pub fn value(&self, index: T::Index) -> &T

Gets the object corresponding to index.

Panics if index is not within the domain.

pub fn index(&self, value: &T) -> T::Index

Gets the index corresponding to value.

Panics if value is not within the domain.

pub fn contains(&self, value: &T) -> bool

Returns true if value is contained in the domain.

pub fn insert(&mut self, value: T) -> T::Index

Adds value to the domain, returning its new index.

pub fn as_vec(&self) -> &IndexVec<T::Index, T>

Returns immutable access to the underlying indexed vector.

pub fn len(&self) -> usize

Returns the number of elements in the domain.

pub fn is_empty(&self) -> bool

Returns true if the domain is empty.

pub fn ensure(&mut self, value: &T) -> T::Index

Similar to IndexedDomain::index, except it adds value to the domain if it does not exist yet.

Trait Implementations

impl<T: IndexedValue + Debug> Debug for IndexedDomain<T>

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

Formats the value using the given formatter.

impl<T: IndexedValue> FromIterator<T> for IndexedDomain<T>

fn from_iter<Iter: IntoIterator<Item = T>>(iter: Iter) -> Self

Creates a value from an iterator.