Struct GenIndexAllocator 

pub struct GenIndexAllocator<I: GenIndex = IndexF64> { /* private fields */ }

Allocator of generational indices.

Implementations

impl<I: GenIndex> GenIndexAllocator<I>

pub fn new() -> Self

Constructs a new GenIndexAllocator.

Examples

let allocator = <GenIndexAllocator>::new();

pub fn with_capacity(capacity: usize) -> Self

Constructs a new, empty GenIndexAllocator with the specified capacity. The allocator will be able to hold exactly capacity elements without reallocating. If capacity is 0, it will not allocate.

Panic

Panics if the capacity overflows.

Examples

let allocator = <GenIndexAllocator>::with_capacity(10);
assert_eq!(allocator.capacity(), 10);

pub fn len(&self) -> usize

Returns the number of elements in the allocator, also referred to as its ‘length’.

Examples

let mut allocator = <GenIndexAllocator>::new();
assert_eq!(allocator.len(), 0);
allocator.create();
assert_eq!(allocator.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if the allocator contains no elements.

Examples

let mut allocator = <GenIndexAllocator>::new();
assert!(allocator.is_empty());
allocator.create();
assert!(!allocator.is_empty());

pub fn capacity(&self) -> usize

Returns the number of elements the allocator can hold without reallocating.

Examples

let allocator = <GenIndexAllocator>::with_capacity(10);
assert_eq!(allocator.capacity(), 10);

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted in the given allocator. The collection may reserve more space to avoid frequent reallocations. After calling reserve, capacity will be greater than or equal to self.len() + additional. Does nothing if capacity is already sufficient.

Panics

Panics if the capacity overflows.

Examples

let mut allocator = <GenIndexAllocator>::new();
allocator.reserve(10);
assert!(allocator.capacity() >= 10);

pub fn clear(&mut self)

Clears the allocator, removing all values. Note that this method has no effect on the allocated capacity of the allocator.

Examples

allocator.create();
allocator.create();
allocator.clear();
assert!(allocator.is_empty());

pub fn create(&mut self) -> I

Creates and returns the next index, allocating more capacity if necessary.

Panics

Panics if the capacity overflows.

Examples

let mut allocator = <GenIndexAllocator>::new();
let i = &allocator.create();
assert!(allocator.contains(i));

pub fn remove(&mut self, i: &I) -> bool

Removes index i from the allocator if exists. Returns a bool indicating whether the allocator originally contains the index.

Examples

let mut allocator = <GenIndexAllocator>::new();
let i = &allocator.create();
assert!(allocator.remove(i));
assert!(!allocator.remove(i));

pub fn contains(&self, i: &I) -> bool

Returns true if the allocator contains the index i .

Examples

let mut allocator = <GenIndexAllocator>::new();
let i = &allocator.create();
assert!(allocator.contains(i));
allocator.remove(i);
assert!(!allocator.contains(i));

pub fn get(&self, idx: &I::Index) -> Option<&I>

Given an index without a generation, get the GenIndex at that slot.

Examples

let mut allocator = <GenIndexAllocator>::new();
let i = allocator.create();
assert_eq!(i, *allocator.get(&i.index()).unwrap());

pub fn retain(&mut self, f: impl FnMut(&I) -> bool)

Retains only the indices specified by the predicate. In other words, removes all indices such that f(index) returns false.

Examples

let mut allocator = <GenIndexAllocator>::new();
let idx1 = &allocator.create();
let idx2 = &allocator.create();
allocator.retain(|idx| idx == idx1);
assert!(allocator.contains(idx1));
assert!(!allocator.contains(idx2));

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

Returns an iterator over the allocator.

Examples

let mut allocator = <GenIndexAllocator>::new();
for i in 0..10 {
    allocator.create();
}

for idx in &allocator {
    println!("{:?}", idx);
}

Trait Implementations

impl<I: Clone + GenIndex> Clone for GenIndexAllocator<I>

where I::Index: Clone,

fn clone(&self) -> GenIndexAllocator<I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug + GenIndex> Debug for GenIndexAllocator<I>

where I::Index: Debug,

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

Formats the value using the given formatter.

impl<I: GenIndex> Default for GenIndexAllocator<I>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, I: GenIndex + Deserialize<'de>> Deserialize<'de> for GenIndexAllocator<I>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<'a, I: GenIndex> IntoIterator for &'a GenIndexAllocator<I>

type Item = &'a I

The type of the elements being iterated over.

type IntoIter = Iter<'a, I>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<I: GenIndex + Serialize> Serialize for GenIndexAllocator<I>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.