Struct flatten_objects::FlattenObjects

pub struct FlattenObjects<T, const CAP: usize> { /* private fields */ }

A container that stores numbered objects.

See the crate-level documentation for more details.

CAP is the maximum number of objects that can be held. It also equals the maximum ID that can be assigned plus one. Currently, CAP must not be greater than 1024.

Implementations

impl<T, const CAP: usize> FlattenObjects<T, CAP>

pub const fn new() -> Self

Creates a new empty FlattenObjects.

pub const fn capacity(&self) -> usize

Returns the maximum number of objects that can be held.

It also equals the maximum ID that can be assigned plus one.

pub const fn count(&self) -> usize

Returns the number of objects that have been added.

pub fn is_assigned(&self, id: usize) -> bool

Returns true if the given id is already be assigned.

pub fn get(&self, id: usize) -> Option<&T>

Returns the reference of the element with the given id if it already be assigned. Otherwise, returns None.

pub fn get_mut(&mut self, id: usize) -> Option<&mut T>

Returns the mutable reference of the element with the given id if it exists. Otherwise, returns None.

pub fn add(&mut self, value: T) -> Option<usize>

Add an object and assigns it a unique ID.

Returns the ID if there is one available. Otherwise, returns None.

pub fn add_at(&mut self, id: usize, value: T) -> Option<usize>

Add an object and assigns it a specific ID.

Returns the ID if it’s not used by others. Otherwise, returns None.

pub fn remove(&mut self, id: usize) -> Option<T>

Removes the object with the given ID.

Returns the object if there is one assigned to the ID. Otherwise, returns None.

After this operation, the ID is freed and can be assigned for next object again.