Skip to main content

Pool

Struct Pool 

Source
pub struct Pool { /* private fields */ }
Expand description

A connection pool for PostgreSQL.

Cheaply cloneable (internally Arc’d). Uses a semaphore to limit max connections and a mutex-protected deque for idle connection management. Designed for <0.5μs checkout latency.

§Lifecycle Callbacks

Three optional callbacks control connection lifecycle:

  • after_connect — runs once per new connection (session setup)
  • before_acquire — runs before handing out a connection (validation)
  • after_release — runs when a connection returns to the pool (cleanup)

§Example

use sentinel_driver::{Config, pool::{Pool, config::PoolConfig}};
use std::time::Duration;

let config = Config::parse("postgres://user:pass@localhost/db")?;
let pool = Pool::new(config, PoolConfig::new().max_connections(10));

let conn = pool.acquire().await?;
// use conn...
// conn is returned to pool on drop

Implementations§

Source§

impl Pool

Source

pub fn new(config: Config, pool_config: PoolConfig) -> Self

Create a new connection pool. No connections are opened until acquire().

Source

pub fn connect_lazy(config: Config, pool_config: PoolConfig) -> Self

Create a pool that defers all connection establishment until the first acquire() call.

This is identical to new() — both are lazy. Provided for API compatibility with connection pools that eagerly open connections.

let config = Config::parse("postgres://user:pass@localhost/db")?;
let pool = Pool::connect_lazy(config, PoolConfig::new());
// No connections opened yet — first acquire() will connect.
Source

pub async fn acquire(&self) -> Result<PooledConnection>

Acquire a connection from the pool.

If an idle connection is available, it’s returned immediately. Otherwise, a new connection is created (up to max_connections). If the pool is full, waits up to acquire_timeout.

Source

pub async fn idle_count(&self) -> usize

Number of idle connections.

Source

pub async fn total_count(&self) -> usize

Total number of connections (idle + in use).

Source

pub fn max_connections(&self) -> usize

Maximum number of connections allowed.

Source

pub async fn metrics(&self) -> PoolMetrics

Get a snapshot of pool metrics.

Trait Implementations§

Source§

impl Clone for Pool

Source§

fn clone(&self) -> Pool

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl Freeze for Pool

§

impl !RefUnwindSafe for Pool

§

impl Send for Pool

§

impl Sync for Pool

§

impl Unpin for Pool

§

impl UnsafeUnpin for Pool

§

impl !UnwindSafe for Pool

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more