Struct ForwardPool 

pub struct ForwardPool { /* private fields */ }

Forward Only Object Pool.

Examples

use nuki::object_pool::*;

#[repr(C)]
#[derive(Debug, Default)]
struct ObjectFoo {
    base: PoolObjectBase,
    val: u64,
}

impl PoolObjectTypeId for ObjectFoo {
    fn pool_object_type_id(&self) -> usize {
        12345678
    }
}

impl ObjectFoo {
    fn base(&self) -> &PoolObjectBase {
        &self.base
    }

    fn base_mut(&mut self) -> &mut PoolObjectBase {
        &mut self.base
    }
}

let mut pool = ForwardPool::with_capacity(1024);
if let Some(foo) = pool.alloc::<ObjectFoo>(None) {
    assert_eq!(foo.base().pool_object_type(), 12345678);
    assert_eq!(
        foo.base().pool_object_size(),
        std::mem::size_of::<ObjectFoo>()
    );
}

Implementations

impl ForwardPool

pub fn with_capacity(capacity: usize) -> Self

Create the poll with capacity.

pub unsafe fn as_ptr(&self) -> *const u8

Returns a raw pointer to the vector’s buffer.

Safety

pub unsafe fn as_mut_ptr(&mut self) -> *mut u8

Returns an unsafe mutable pointer to the vector’s buffer.

Safety

pub fn space(&self) -> usize

Return available bytes.

pub fn used(&self) -> usize

Return used bytes.

pub fn alloc<T: PoolObjectTypeId + Default>( &mut self, def_val: Option<T>, ) -> Option<&mut T>

Allocate an object and return the mutable reference.

pub fn clear(&mut self)

Clear all objects in the pool.

pub fn iter(&self) -> ForwardPoolIter<'_>

Returns an iterator over the objects.

pub fn iter_mut(&mut self) -> ForwardPoolIterMut<'_>

Returns an iterator that allows modifying each object.

Trait Implementations

impl Debug for ForwardPool

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

Formats the value using the given formatter.