Struct Pool 

pub struct Pool<M: Manage, X: Exchange<M> = NoExchange> { /* private fields */ }

A sharded connection pool for compio.

Cheap to clone and Send + Sync: clone it onto every compio thread. Each thread transparently gets its own shard, so the acquire fast path touches no atomics and no locks.

The X parameter selects the cross-thread strategy. The default, NoExchange, keeps threads fully independent. Swap in a Reservoir — which requires Detach — to let idle connections migrate to whichever thread needs them.

Implementations

impl<M: Manage> Pool<M>

pub fn new(manager: M, config: Config) -> Self

Builds a pool with no cross-thread sharing.

pub fn builder(manager: M) -> Builder<M, NoExchange>

Starts a Builder.

impl<M: Manage, X: Exchange<M>> Pool<M, X>

pub fn with_exchange(manager: M, config: Config, exchange: X) -> Self

Builds a pool with an explicit cross-thread Exchange.

pub fn manager(&self) -> &M

The manager, for callers that need to reach configuration through it.

pub fn config(&self) -> &Config

The configuration this pool was built with.

pub fn local_size(&self) -> usize

Connections owned by this thread’s shard, idle plus checked out.

pub fn local_idle(&self) -> usize

Idle connections sitting in this thread’s shard.

pub fn metrics(&self) -> Metrics

A snapshot of pool activity.

pub fn invalidate(&self)

Retires every connection created before this call.

Live checkouts keep working and are closed when returned. Use after a credential rotation or a failover, where existing sockets point at the wrong place but the pool itself is still wanted.

pub fn close(&self)

Closes the pool.

Subsequent acquire calls fail with Error::Closed. This thread’s idle connections are closed immediately; other threads’ are closed when they next touch the pool or when their thread exits.

pub fn is_closed(&self) -> bool

Whether close has been called.

pub async fn warm(&self) -> Result<(), Error<M::Error>>

Opens connections on the current thread up to min_idle.

Call this once per compio thread at startup so the first real request does not pay for a handshake.

pub async fn acquire(&self) -> Result<Pooled<M, X>, Error<M::Error>>

Checks out a connection, waiting if the shard is at max_size.

Must be called on a compio runtime thread. Honours Config::acquire_timeout.

Trait Implementations

impl<M: Manage, X: Exchange<M>> Clone for Pool<M, X>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Manage, X: Exchange<M>> Debug for Pool<M, X>

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

Formats the value using the given formatter.