Struct logicsim::data_structures::Slab

pub struct Slab<T: Sized> { /* fields omitted */ }

Simple slab allocator. Stores items of the same type and can reuse removed indexes.

Example

let mut s = Slab::new();

let index = s.insert(5);
assert_eq!(s.get(index), Some(&5));

assert_eq!(s.remove(index), Some(5));

assert_eq!(s.get(index), None);

Implementations

impl<T: Sized> Slab<T>

pub fn new() -> Self

Returns an empty Slab.

pub fn insert(&mut self, item: T) -> SlabIndex

Inserts an item into the slab and returns its index.

Will reuse an empty index if one is available.

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

Returns a mutable reference to the item at index.

Returns None if index has been removed.

pub fn get(&self, index: SlabIndex) -> Option<&T>

Return a reference to the item at index.

Returns None if index has been removed.

pub fn remove(&mut self, index: SlabIndex) -> Option<T>

Removes an item from the Slab and returns it.

Returns None if index has been removed. index will be reused on the next call to Slab::insert.

pub fn len(&self) -> usize

Returns the number of items in the slab.

This is different from the number of allocated slots in the slab, see Slab::total_len

pub fn is_empty(&self) -> bool

Returns true if the number of items in the slab is 0.

This is different from the number of allocated slots in the slab, see Slab::total_len

pub fn total_len(&self) -> usize

Returns the number of allocated slots in the slab, some of them could be empty.

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over pairs of (SlabIndex, [&T]).

pub unsafe fn get_very_unsafely(&self, index: SlabIndex) -> &T

Returns the item at index without performing bounds checking or checking if the slot contains initialized data.

Safety

This function is safe if index < Slab::total_len() and the item at index has not been removed. Will panic in debug mode if the invariants are broken.

Annoyingly long names discourage use and make you really think about what you are doing.

Trait Implementations

impl<T: Clone + Sized> Clone for Slab<T>

pub fn clone(&self) -> Slab<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Sized> Debug for Slab<T>

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

Formats the value using the given formatter.

impl<T> Default for Slab<T>

pub fn default() -> Self

Returns the "default value" for a type.

impl<T> IntoIterator for Slab<T>

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

type Item = (SlabIndex, T)

The type of the elements being iterated over.

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.