Struct Builder 

pub struct Builder<T: Default> { /* private fields */ }

A builder for creating a Pool with custom configuration.

Example

use concurrent_pool::Builder;

let mut builder = Builder::<usize>::new();
let pool = builder.capacity(10).prealloc(5).build();
assert_eq!(pool.capacity(), 10);

Implementations

impl<T: Default> Builder<T>

pub fn new() -> Self

Create a new builder with default configuration.

pub fn prealloc(&mut self, prealloc: usize) -> &mut Self

Set the number of preallocated items in the pool.

pub fn capacity(&mut self, capacity: usize) -> &mut Self

Set the maximum capacity of the pool.

pub fn clear_func(&mut self, func: fn(&mut T)) -> &mut Self

Set the function to clear an item before it is returned to the pool.

pub fn auto_reclaim(&mut self, enable: bool) -> &mut Self

Enable or disable auto reclaiming allocated items and free them to reduce memory usage.

pub fn enable_auto_reclaim(&mut self) -> &mut Self

Enable auto reclaiming allocated items and free them to reduce memory usage.

pub fn surpluspull_threshold_for_reclaim( &mut self, threshold: usize, ) -> &mut Self

Set the threshold of surplus-pull continuous occurrence to trigger reclamation when auto_reclaim is enabled.

pub fn idle_threshold_for_surpluspull(&mut self, threshold: usize) -> &mut Self

Set the threshold for idle items to judge as a surplus-pull when auto_reclaim is enabled.

pub fn build(&mut self) -> Pool<T>

Build the pool with the current configuration.