Struct bb8::Pool

pub struct Pool<M> where
    M: ManageConnection,  { /* fields omitted */ }

A generic connection pool.

Methods

impl<M: ManageConnection> Pool<M>

pub fn builder() -> Builder<M>

Returns a Builder instance to configure a new pool.

pub fn state(&self) -> State

Returns information about the current state of the pool.

pub fn run<'a, T, E, U, F>(
    &self,
    f: F
) -> impl Future<Item = T, Error = RunError<E>> + Send + 'a where
    F: FnOnce(M::Connection) -> U + Send + 'a,
    U: IntoFuture<Item = (T, M::Connection), Error = (E, M::Connection)> + Send + 'a,
    U::Future: Send + 'a,
    E: From<M::Error> + Send + 'a,
    T: Send + 'a, 

Run a closure with a Connection.

The closure will be executed on the tokio event loop provided during the construction of this pool, so it must be Send. The closure's return value is also Send so that the Future can be consumed in contexts where Send is needed.

Futures 0.3 + Async/Await

In order to use this with Futures 0.3 + async/await syntax, use .boxed().compat() on the inner future in order to convert it to a version 0.1 Future.

// Note that this version of `futures` is 0.3
use futures::compat::{Future01CompatExt}; // trait provides `.compat()`

async fn future_03_example(client: Client) -> Result<(String, Client), (Error, Client)> {
    Ok(("Example".to_string(), client))
}

client.run(|client| {
    future_03_example(client).boxed().compat()
})

pub fn dedicated_connection(
    &self
) -> impl Future<Item = M::Connection, Error = M::Error> + Send

Get a new dedicated connection that will not be managed by the pool. An application may want a persistent connection (e.g. to do a postgres LISTEN) that will not be closed or repurposed by the pool.

This method allows reusing the manager's configuration but otherwise bypassing the pool

Trait Implementations

impl<M> Clone for Pool<M> where
    M: ManageConnection, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Debug for Pool<M> where
    M: ManageConnection, 

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

Formats the value using the given formatter.