Struct ika::Pool

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

Let's go swimming!

Implementations

impl<T> Pool<T>

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

Instantiate an object. Undefined behavior if self.is_empty().
Object may have weird, possibly uninitialized, data.

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

Instantiate an object. Will return None if self.is_empty().
Object may have weird, possibly uninitialized, data.

pub fn spawn_exact(&mut self, count: usize) -> Vec<&mut T>

Instantiate exactly count objects. If count > self.available(), the resulting vector will be empty.
Object may have weird, possibly uninitialized, data.

pub fn spawn_some(&mut self, count: usize) -> Vec<&mut T>

Instantiate some objects. If count > self.available(), the resulting vector will have a length < count, and may be empty.
Object may have weird, possibly uninitialized, data.

pub fn reclaim<F: FnMut(&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.
Preserves ordering of the pool.

pub fn reclaim_unstable<F: FnMut(&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.
Doesn't necessarity preserve ordering of the pool.

pub fn attach(&mut self, at: usize, obj: T)

Move an object into the pool. Will resize the pool.

pub fn detach(&mut self, at: usize) -> T

Move an object out of the pool by index. Will resize the pool.
Panics if index is out of bounds.

pub fn get(&self, at: usize) -> Option<&T>

pub fn get_mut(&mut self, at: usize) -> Option<&mut T>

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

Important traits for Iter<'a, T>

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

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

Important traits for IterMut<'a, T>

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

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 len(&self) -> usize

Number of objects in use in the pool.

pub fn available(&self) -> usize

Number of free objects in the pool.

pub fn capacity(&self) -> usize

Number of total objects in the pool.

impl<T: Default> Pool<T>

pub fn new(size: usize) -> Self

Create a new pool with a starting size of size. Objects will be initialized with T::default()

pub fn please_spawn(&mut self) -> &mut T

Please instantiate an object. Will resize the pool if self.is_empty().
Intializes new object with T::default().

pub fn please_spawn_some(&mut self, count: usize) -> Vec<&mut T>

Instantiate exactly count objects. If count > self.available(), the pool will be resized to account for the difference.
Intializes new objects with T::default().

Trait Implementations

impl<T: Clone> Clone for Pool<T>

fn clone(&self) -> Pool<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Pool<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Pool<T>

fn default() -> Pool<T>

Returns the "default value" for a type.

impl<T: Eq> Eq for Pool<T>

impl<'a, T> IntoIterator for &'a Pool<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Pool<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq<Pool<T>> for Pool<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> StructuralEq for Pool<T>