Struct Pool

pub struct Pool { /* private fields */ }

Asynchronous pool of MySql connections.

Actually Pool is a shared reference, i.e. every clone will lead to the same instance created with Pool::new. Also Pool satisfies Send and Sync, so you don’t have to wrap it into an Arc or Mutex.

Note that you will probably want to await Pool::disconnect before dropping the runtime, as otherwise you may end up with a number of connections that are not cleanly terminated.

Implementations

impl Pool

pub fn new<O>(opts: O) -> Pool

where Opts: TryFrom<O>, <Opts as TryFrom<O>>::Error: Error,

Creates a new pool of connections.

Panic

It’ll panic if Opts::try_from(opts) returns error.

pub fn metrics(&self) -> Arc<Metrics>

Returns metrics for the connection pool.

pub fn from_url<T: AsRef<str>>(url: T) -> Result<Pool>

Creates a new pool of connections.

pub fn get_conn(&self) -> GetConn

Async function that resolves to Conn.

pub async fn start_transaction( &self, options: TxOpts, ) -> Result<Transaction<'static>>

Starts a new transaction.

pub fn disconnect(self) -> DisconnectPool

Async function that disconnects this pool from the server and resolves to ().

Note: This Future won’t resolve until all active connections, taken from it, are dropped or disonnected. Also all pending and new GetConn’s will resolve to error.

Trait Implementations

impl Clone for Pool

fn clone(&self) -> Pool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pool

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

Formats the value using the given formatter.

impl<'a> ToConnection<'a, 'static> for &'a Pool

fn to_connection(self) -> ToConnectionResult<'a, 'static>

Converts self to a connection.

impl ToConnection<'static, 'static> for Pool

fn to_connection(self) -> ToConnectionResult<'static, 'static>

Converts self to a connection.