Struct PoolConnection 

pub struct PoolConnection<C: Connection> { /* private fields */ }

A connection managed by a [Pool][crate::pool::Pool].

Will be returned to the pool on-drop.

Implementations

impl<C: Connection> PoolConnection<C>

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 detach(self) -> C

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) -> C

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: Connection> AsMut<C> for PoolConnection<C>

fn as_mut(&mut self) -> &mut C

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

impl<C: Connection> AsRef<C> for PoolConnection<C>

fn as_ref(&self) -> &C

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

impl<C: Connection> Debug for PoolConnection<C>

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

Formats the value using the given formatter.

impl<C: Connection> Deref for PoolConnection<C>

type Target = C

The resulting type after dereferencing.

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

Dereferences the value.

impl<C: Connection> DerefMut for PoolConnection<C>

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

Mutably dereferences the value.

impl<C: Connection> Drop for PoolConnection<C>

Returns the connection to the [Pool][crate::pool::Pool] it was checked-out from.

fn drop(&mut self)

Executes the destructor for this type.

impl<'c, C: Connection> From<PoolConnection<C>> for MaybePoolConnection<'c, C>

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

Converts to this type from the input type.