Struct Hooks 

pub struct Hooks { /* private fields */ }

Optional pool hooks.

Use this with Pool::with_hooks when you want connection setup or validation around pool checkout.

This stays empty by default:

quex::Hooks::new();

A more typical setup looks like this:

quex::Hooks::new()
    .on_connect(|conn| Box::pin(async move {
        conn.query("create table if not exists users(id integer primary key)")
            .await?;
        Ok(())
    }))
    .before_acquire(|conn| Box::pin(async move {
        conn.query("select 1").await?;
        Ok(quex::AcquireDecision::Accept)
    }));

Implementations

impl Hooks

pub fn new() -> Hooks

Creates an empty hook set.

pub fn on_connect<F>(self, hook: F) -> Hooks

where F: Send + Sync + 'static + for<'a> Fn(&'a mut PooledConnection) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>,

Runs after the pool opens a fresh connection.

Use this for setup that should happen once per new connection.

This does not run when the pool reuses an idle connection.

pub fn before_acquire<F>(self, hook: F) -> Hooks

where F: Send + Sync + 'static + for<'a> Fn(&'a mut PooledConnection) -> Pin<Box<dyn Future<Output = Result<AcquireDecision, Error>> + Send + 'a>>,

Runs before the pool returns a checked-out connection.

Use this to validate the connection and decide whether the pool should hand it out or discard it and try again.

Return AcquireDecision::Accept to hand the connection to the caller, or AcquireDecision::Retry to discard this candidate and let the pool try another one.

Trait Implementations

impl Default for Hooks

fn default() -> Hooks

Returns the “default value” for a type.