Struct components::engine::d2::util::Pool

pub struct Pool<A> where
    A: Default + Clone,  { /* private fields */ }

A pool of reusable objects that can be used to avoid allocation. *

Implementations

impl<A> Pool<A> where
    A: Default + Clone, 

pub fn new(allocator: Box<dyn Fn() + 'static, Global>) -> Pool<A>

@param allocator A fn that creates a new object.

pub fn take(&mut self) -> Option<A>

Take an object from the pool. If the pool is empty, a new object will be allocated.

You should later release the object back into the pool by calling put().

pub fn put(&mut self, object: A)

Put an object into the pool. This should be called to release objects previously claimed with take(). Can also be called to pre-allocate the pool with new objects.

pub fn set_size(&mut self, size: usize) -> &Pool<A>

Resizes the pool. If the given size is larger than the current number of pooled objects, new objects are allocated to expand the pool. Otherwise, objects are trimmed out of the pool.

@returns This instance, for chaining.

pub fn set_capacity(&mut self, capacity: usize) -> &Pool<A>

Sets the maximum capacity of the pool. By default, the pool can grow to any size.

@returns This instance, for chaining.