Struct PoolConnection

pub struct PoolConnection<DB: Database> { /* private fields */ }

A connection managed by a Pool.

Will be returned to the pool on-drop.

Implementations

impl<DB: Database> PoolConnection<DB>

pub async fn close(self) -> Result<(), Error>

Close this connection, allowing the pool to open a replacement.

Equivalent to calling .detach() then .close(), but the connection permit is retained for the duration so that the pool may not exceed max_connections.

pub fn close_on_drop(&mut self)

Close this connection on-drop, instead of returning it to the pool.

May be used in cases where waiting for the .close() call to complete is unacceptable, but you still want the connection to be closed gracefully so that the server can clean up resources.

pub fn detach(self) -> DB::Connection

Detach this connection from the pool, allowing it to open a replacement.

Note that if your application uses a single shared pool, this effectively lets the application exceed the max_connections setting.

If min_connections is nonzero, a task will be spawned to replace this connection.

If you want the pool to treat this connection as permanently checked-out, use .leak() instead.

pub fn leak(self) -> DB::Connection

Detach this connection from the pool, treating it as permanently checked-out.

This effectively will reduce the maximum capacity of the pool by 1 every time it is used.

If you don’t want to impact the pool’s capacity, use .detach() instead.

Trait Implementations

impl<'c, DB: Database> Acquire<'c> for &'c mut PoolConnection<DB>

type Database = DB

type Connection = &'c mut <DB as Database>::Connection

fn acquire(self) -> BoxFuture<'c, Result<Self::Connection, Error>>

fn begin(self) -> BoxFuture<'c, Result<Transaction<'c, DB>, Error>>

impl<DB: Database> AsMut<<DB as Database>::Connection> for PoolConnection<DB>

fn as_mut(&mut self) -> &mut DB::Connection

Converts this type into a mutable reference of the (usually inferred) input type.

impl<DB: Database> AsRef<<DB as Database>::Connection> for PoolConnection<DB>

fn as_ref(&self) -> &DB::Connection

Converts this type into a shared reference of the (usually inferred) input type.

impl<DB: Database> Debug for PoolConnection<DB>

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

Formats the value using the given formatter.

impl<DB: Database> Deref for PoolConnection<DB>

type Target = <DB as Database>::Connection

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<DB: Database> DerefMut for PoolConnection<DB>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<DB: Database> Drop for PoolConnection<DB>

Returns the connection to the Pool it was checked-out from.

fn drop(&mut self)

Executes the destructor for this type.

impl<'c, DB: Database> From<PoolConnection<DB>> for MaybePoolConnection<'c, DB>

fn from(v: PoolConnection<DB>) -> Self

Converts to this type from the input type.