Struct fj_kernel::storage::Store

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

Append-only object storage

Implementations

impl<T> Store<T>

pub fn new() -> Self

Construct a new instance of Store

Equivalent to calling Store::with_block_size with a default block size.

pub fn with_block_size(block_size: usize) -> Self

Construct a new instance of Store using the provided block size

pub fn reserve(&self) -> Handle<T>

Reserve a slot for an object in the store

This method returns a handle to the reserved slot. That handle does not refer to an object yet! Attempting to dereference the handle before it has been used to insert an object into the store, will result in a panic.

Usually, you’d acquire one handle, then immediately use it to insert an object using Store::insert. The methods are separate to support more advanced use cases, like inserting objects that refer to each other.

pub fn insert(&mut self, handle: Handle<T>, object: T)

Insert an object into the store

Panics

Panics, if the passed Handle does not refer to a reserved slot. This can only be the case, if the handle has been used to insert an object before.

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

Iterate over all objects in this store

Trait Implementations

impl<T: Debug> Debug for Store<T>

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

Formats the value using the given formatter.

impl<T> Default for Store<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T> IntoIterator for &'a Store<T>

type Item = Handle<T>

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.