Struct ika::Pool

pub struct Pool<T: Default> { /* fields omitted */ }

Let's go swimming!

Implementations

impl<T: Default> Pool<T>

pub fn new(size: usize) -> Self

Create a new pool with a maximum capacity of size.

pub fn spawn(&mut self) -> Option<&mut T>

Instantiate an object. Will return None if self.is_empty(). Object may have weird data, but it will have at least been initialized with T::default().

pub unsafe fn spawn_unchecked(&mut self) -> &mut T

Instantiate an object. Undefined behavior if self.is_empty(). Object may have weird data, but it will have at least been initialized with T::default().

pub fn reclaim<F: Fn(&T) -> bool>(&mut self, kill_fn: F)

Kill objects in the pool based on kill_fn. If kill_fn returns true, the object will be recycled.

pub fn iter(&self) -> Iter<T>ⓘ

Important traits for Iter<'a, T>

impl<'a, T: Default> Iterator for Iter<'a, T> type Item = &'a T;

Returns an iterator over the pool.

pub fn iter_mut(&mut self) -> IterMut<T>ⓘ

Important traits for IterMut<'a, T>

impl<'a, T: Default> Iterator for IterMut<'a, T> type Item = &'a mut T;

Returns a mutable iterator over the pool.

pub fn sort_the_dead(&mut self)

Sort pointers to available objects for better cache locality.

pub fn is_empty(&self) -> bool

Returns whether there are available objects in the pool or not.

pub fn available(&self) -> usize

Number of free objects in the pool.

impl<T: Recyclable> Pool<T>

pub fn spawn_new(&mut self) -> Option<&mut T>

Instantiate an object. Will return None if self.is_empty(). Object will be reset based on its implementation of Recyclable.

pub unsafe fn spawn_new_unchecked(&mut self) -> &mut T

Instantiate an object. Undefined behavior if self.is_empty(). Object will be reset based on its implementation of Recyclable.