Type Alias Pool

Help

pub type Pool = Pool<Manager, Object<Manager>>;

Expand description

Type alias for using deadpool::managed::Pool with rusqlite.

Aliased Type§

struct Pool { /* private fields */ }

Implementations

Source §

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

Source

pub fn builder(manager: M) -> PoolBuilder<M, W>

Instantiates a builder for a new Pool.

This is the only way to create a Pool instance.

Source

pub async fn get(&self) -> Result<W, PoolError<<M as Manager>::Error>>

Retrieves an Object from this Pool or waits for one to become available.

§Errors

See PoolError for details.

Source

pub async fn timeout_get( &self, timeouts: &Timeouts, ) -> Result<W, PoolError<<M as Manager>::Error>>

Retrieves an Object from this Pool using a different timeout than the configured one.

§Errors

See PoolError for details.

Source

pub fn resize(&self, max_size: usize)

Resize the pool. This change the max_size of the pool dropping excess objects and/or making space for new ones.

If the pool is closed this method does nothing. The Pool::status method always reports a max_size of 0 for closed pools.

Source

pub fn retain( &self, predicate: impl FnMut(&<M as Manager>::Type, Metrics) -> bool, ) -> RetainResult<<M as Manager>::Type>

Retains only the objects specified by the given function.

This function is typically used to remove objects from the pool based on their current state or metrics.

Caution: This function blocks the entire pool while it is running. Therefore the given function should not block.

The following example starts a background task that runs every 30 seconds and removes objects from the pool that haven’t been used for more than one minute.

let interval = Duration::from_secs(30);
let max_age = Duration::from_secs(60);
tokio::spawn(async move {
    loop {
        tokio::time::sleep(interval).await;
        pool.retain(|_, metrics| metrics.last_used() < max_age);
    }
});

Source