Struct ConnectionPool 

pub struct ConnectionPool<T>(/* private fields */);

A thread-safe, blocking connection pool. Cheaply clonable (clones share one pool).

Implementations

impl<T> ConnectionPool<T>

where T: Clone + Eq + Hash + Send + Sync + 'static,

pub fn new( factory: impl ConnectionFactory<T> + 'static, config: PoolConfig, options: Option<PoolOptions<T>>, ) -> Result<Self, PoolError>

Builds a pool, validating config.

pub fn name(&self) -> &str

The pool’s name.

pub fn open(&self) -> Result<(), PoolError>

Warms up min_size connections and starts the background maintenance thread. Optional: without it the pool is purely lazy. Idempotent.

pub fn close(&self, timeout: Option<f64>)

Closes idle connections now; checked-out ones close when released. Blocked acquire callers get a PoolError::Closed. Idempotent.

timeout (None = don’t wait) drains gracefully: wait up to that many seconds for in-use connections to return before giving up (they still close on release). 0 returns at once.

pub fn is_closed(&self) -> bool

Whether close has been called.

pub fn acquire(&self, timeout: Timeout) -> Result<T, PoolError>

Gets a connection. Timeout::Unset uses config.acquire_timeout; Timeout::Infinite waits forever; Timeout::Of(0.0) never waits.

pub fn release(&self, conn: T) -> Result<(), PoolError>

Returns a connection to the pool for reuse.

pub fn discard(&self, conn: T) -> Result<(), PoolError>

Returns a connection but forces it to be closed instead of reused.

pub fn release_with_error( &self, conn: T, error: &(dyn Error + 'static), ) -> Result<(), PoolError>

Returns a connection, signalling that the caller’s work raised error; the pool discards the connection if the factory deems the error fatal or validation fails.

pub fn with_connection<R>( &self, timeout: Timeout, f: impl FnOnce(&T) -> R, ) -> Result<R, PoolError>

Borrows a connection for the duration of f, releasing it afterwards.

pub fn stats(&self) -> PoolStats

An immutable snapshot of pool counters and gauges.

pub fn run_maintenance(&self)

Performs one maintenance sweep (evict expired/over-idle, optionally validate idle, refill to min_size, flag leaks). Runs periodically after open; public for tests and cron-style use.

Trait Implementations

impl<T> Clone for ConnectionPool<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.