Struct ico_memory::mem::IndexedDataStore

pub struct IndexedDataStore<'a, T> { /* fields omitted */ }

Methods

impl<'a, T> IndexedDataStore<'a, T>

pub const unsafe fn from_raw(
    data: &'a *mut MaybeUninit<IndexedData<T>>,
    capacity: u32
) -> IndexedDataStore<'a, T>

pub fn high_water_mark(&self) -> u32

How much of the buffer has ever been used.

pub fn active(&self) -> u32

How many objects are currently stored and accessible.

pub fn destroyed(&self) -> u32

How many objects are currently stored but marked destroyed.

pub fn available(&self) -> u32

How much free space. Capcity - (active + destroyed).

pub fn capacity(&self) -> u32

Total fixed capacity.

pub fn retain(&'a self, handle: IndexedHandle) -> Nullable<IndexedRef<'a, T>>

Retain a strong reference. If no reference exists returns None, otherwise, this increments the reference count and returns the reference.
It is up to the user to manually release() the returned reference when they are finished.

pub unsafe fn get(&'a self, reference: &'a IndexedRef<T>) -> &'a mut T

It is imperative users not hold these references

pub fn clone(&'a self, reference: &'a IndexedRef<T>) -> IndexedRef<T>

pub fn release(&'a self, reference: IndexedRef<T>)

Release a strong reference. This decrements the reference count.

pub fn store(&self, value: T) -> IndexedHandle

pub fn free(&self, handle: IndexedHandle) -> bool

Trait Implementations

impl<'a, T> Drop for IndexedDataStore<'a, T>

fn drop(&mut self)

Executes the destructor for this type.