Struct deadpool::managed::PoolBuilder

pub struct PoolBuilder<M, W = Object<M>>
where
    M: Manager,
    W: From<Object<M>>,
{ /* private fields */ }

Builder for Pools.

Instances of this are created by calling the Pool::builder() method.

Implementations

impl<M, W> PoolBuilder<M, W>

where M: Manager, W: From<Object<M>>,

pub fn build(self) -> Result<Pool<M, W>, BuildError>

Builds the Pool.

Errors

See BuildError for details.

pub fn config(self, value: PoolConfig) -> Self

Sets a PoolConfig to build the Pool with.

pub fn max_size(self, value: usize) -> Self

Sets the PoolConfig::max_size.

pub fn timeouts(self, value: Timeouts) -> Self

Sets the PoolConfig::timeouts.

pub fn wait_timeout(self, value: Option<Duration>) -> Self

Sets the Timeouts::wait value of the PoolConfig::timeouts.

pub fn create_timeout(self, value: Option<Duration>) -> Self

Sets the Timeouts::create value of the PoolConfig::timeouts.

pub fn recycle_timeout(self, value: Option<Duration>) -> Self

Sets the Timeouts::recycle value of the PoolConfig::timeouts.

pub fn queue_mode(self, value: QueueMode) -> Self

Sets the PoolConfig::queue_mode.

pub fn post_create(self, hook: impl Into<Hook<M>>) -> Self

Attaches a post_create hook.

The given hook will be called each time right after a new Object has been created.

pub fn pre_recycle(self, hook: impl Into<Hook<M>>) -> Self

Attaches a pre_recycle hook.

The given hook will be called each time right before an Object will be recycled.

pub fn post_recycle(self, hook: impl Into<Hook<M>>) -> Self

Attaches a post_recycle hook.

The given hook will be called each time right after an Object has been recycled.

pub fn runtime(self, value: Runtime) -> Self

Sets the Runtime.

Important

The Runtime is optional. Most Pools don’t need a Runtime. If want to utilize timeouts, however a Runtime must be specified as you will otherwise get a PoolError::NoRuntimeSpecified when trying to use Pool::timeout_get().

PoolBuilder::build() will fail with a BuildError::NoRuntimeSpecified if you try to build a Pool with timeouts and no Runtime specified.

Trait Implementations

impl<M, W> Debug for PoolBuilder<M, W>

where M: Debug + Manager, W: From<Object<M>>,

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

Formats the value using the given formatter.