Struct Client

pub struct Client<M: Connector> { /* private fields */ }

Generic connection and connection pool.

This struct can be cloned and transferred across thread boundaries and uses reference counting for its internal state.

Implementations

impl<M: Connector> Client<M>

pub fn builder(connector: M) -> ClientBuilder<M>

Instantiates a builder for a new Client.

This is the only way to create a Client instance.

pub async fn get( &self, key: M::Key, ) -> Result<PooledConnection<M>, ClientError<M::Error>>

Retrieves an PooledConnection from this Client or waits for one to become available.

Errors

See ClientError for details.

pub async fn timeout_get( &self, key: M::Key, timeouts: &Timeouts, ) -> Result<PooledConnection<M>, ClientError<M::Error>>

Retrieves an PooledConnection from this Client using a different timeout than the configured one.

Errors

See ClientError for details.

pub fn timeouts(&self) -> Timeouts

Get current timeout configuration

pub fn close(&self)

Closes this Client.

All current and future tasks waiting for PooledConnections will return ClientError::Closed immediately.

This operation resizes the pool to 0.

pub fn is_closed(&self) -> bool

Indicates whether this Client has been closed.

pub fn status(&self) -> Status

Retrieves Status of this Client.

pub fn connector(&self) -> &M

Returns Connector of this Client.

Trait Implementations

impl<M: Connector> Clone for Client<M>

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 Client<M>

where M: Debug + Connector, M::Connection: Debug,

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

Formats the value using the given formatter.