Struct SimpleVecPool

pub struct SimpleVecPool<T> { /* private fields */ }

Simple vector pool.

The pool holds used vectors while keeping their capacities to avoid frequent memory allocation.

Implementations

impl<T> SimpleVecPool<T>

pub const fn new() -> Self

Creates a new empty vector pool.

Examples

use my_ecs::ds::SimpleVecPool;

let mut pool = SimpleVecPool::<i32>::new();

pub fn request(&mut self) -> usize

Returns an index to a vector of the pool.

The pool prefers to reuse vector, therefore caller will receive an index to a used vector if the pool contains used vectors. In that case, the vector is completed cleared while keeping its capacity. If the pool doesn’t have any used vectors in it, a new vector is created.

Examples

use my_ecs::ds::SimpleVecPool;

let mut pool = SimpleVecPool::<i32>::new();

let index = pool.request();
let v = pool.get(index);
v.reserve(10);
drop(v);

pool.release(index);
let index = pool.request(); // pool will return the used vector
let v = pool.get(index);
assert!(v.is_empty());
assert!(v.capacity() >= 10);

pub fn release(&mut self, index: usize)

Lets the pool know the end of use of a vector.

Examples

use my_ecs::ds::SimpleVecPool;

let mut pool = SimpleVecPool::<i32>::new();
let index0 = pool.request();
pool.release(index0);

let index1 = pool.request(); // pool will return the used vector
assert_eq!(index0, index1);

pub fn get(&mut self, index: usize) -> &mut Vec<T>

Returns a mutable reference to a vector at the given index.

Examples

use my_ecs::ds::SimpleVecPool;

let mut pool = SimpleVecPool::new();
let index = pool.request();
let v = pool.get(index);
v.push(0);

Trait Implementations

impl<T: Debug> Debug for SimpleVecPool<T>

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

Formats the value using the given formatter.

impl<T> Default for SimpleVecPool<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Resource for SimpleVecPool<T>

where T: Send + 'static,