Struct crayon::utils::object_pool::ObjectPool

pub struct ObjectPool<T: Sized> { /* fields omitted */ }

A named object collections. Every time u create or free a handle, a attached instance T will be created/ freed.

Methods

impl<T: Sized> ObjectPool<T>

fn new() -> Self

Constructs a new, empty ObjectPool.

fn with_capacity(capacity: usize) -> Self

Constructs a new ObjectPool with the specified capacity.

fn create(&mut self, value: T) -> Handle

Creates a T and named it with Handle.

fn get_mut<H>(&mut self, handle: H) -> Option<&mut T> where
    H: Borrow<Handle>, 

Returns mutable reference to internal value with name Handle.

fn get<H>(&self, handle: H) -> Option<&T> where
    H: Borrow<Handle>, 

Returns immutable reference to internal value with name Handle.

fn is_alive<H>(&self, handle: H) -> bool where
    H: Borrow<Handle>, 

Returns true if this Handle was created by ObjectPool, and has not been freed yet.

fn free<H>(&mut self, handle: H) -> Option<T> where
    H: Borrow<Handle>, 

Recycles the value with name Handle.

fn free_if<P>(&mut self, predicate: P) -> FreeIter<T, P> where
    P: FnMut(&T) -> bool, 

Remove all objects matching with predicate from pool incrementally.

fn len(&self) -> usize

Returns the total number of alive handle in this ObjectPool.

fn iter(&self) -> HandleIter

Returns an iterator over the ObjectPool.