Struct diesel::r2d2::Pool

source ·
pub struct Pool<M>(/* private fields */)
where
    M: ManageConnection;
Available on crate feature r2d2 only.
Expand description

A generic connection pool.

Implementations§

source§

impl<M> Pool<M>

source

pub fn new(manager: M) -> Result<Pool<M>, Error>

Creates a new connection pool with a default configuration.

source

pub fn builder() -> Builder<M>

Returns a builder type to configure a new pool.

source

pub fn get(&self) -> Result<PooledConnection<M>, Error>

Retrieves a connection from the pool.

Waits for at most the configured connection timeout before returning an error.

source

pub fn get_timeout( &self, timeout: Duration, ) -> Result<PooledConnection<M>, Error>

Retrieves a connection from the pool, waiting for at most timeout

The given timeout will be used instead of the configured connection timeout.

source

pub fn try_get(&self) -> Option<PooledConnection<M>>

Attempts to retrieve a connection from the pool if there is one available.

Returns None if there are no idle connections available in the pool. This method will not block waiting to establish a new connection.

source

pub fn state(&self) -> State

Returns information about the current state of the pool.

source

pub fn max_size(&self) -> u32

Returns the configured maximum pool size.

source

pub fn min_idle(&self) -> Option<u32>

Returns the configured mimimum idle connection count.

source

pub fn test_on_check_out(&self) -> bool

Returns if the pool is configured to test connections on check out.

source

pub fn max_lifetime(&self) -> Option<Duration>

Returns the configured maximum connection lifetime.

source

pub fn idle_timeout(&self) -> Option<Duration>

Returns the configured idle connection timeout.

source

pub fn connection_timeout(&self) -> Duration

Returns the configured connection timeout.

Trait Implementations§

source§

impl<M> Clone for Pool<M>

Returns a new Pool referencing the same state as self.

source§

fn clone(&self) -> Pool<M>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<M> Debug for Pool<M>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<M> Freeze for Pool<M>

§

impl<M> !RefUnwindSafe for Pool<M>

§

impl<M> Send for Pool<M>

§

impl<M> Sync for Pool<M>

§

impl<M> Unpin for Pool<M>

§

impl<M> !UnwindSafe for Pool<M>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoSql for T

source§

fn into_sql<T>(self) -> AsExprOf<Self, T>

Convert self to an expression for Diesel’s query builder. Read more
source§

fn as_sql<'a, T>(&'a self) -> AsExprOf<&'a Self, T>

Convert &self to an expression for Diesel’s query builder. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V