Struct r2d2::Pool [−][src]
pub struct Pool<M: ManageConnection>(_);
A generic connection pool.
Methods
impl<M> Pool<M> where
M: ManageConnection, [src]
impl<M> Pool<M> where
M: ManageConnection, pub fn new(manager: M) -> Result<Pool<M>, Error>[src]
pub fn new(manager: M) -> Result<Pool<M>, Error>Creates a new connection pool with a default configuration.
pub fn builder() -> Builder<M>[src]
pub fn builder() -> Builder<M>Returns a builder type to configure a new pool.
pub fn get(&self) -> Result<PooledConnection<M>, Error>[src]
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.
pub fn try_get(&self) -> Option<PooledConnection<M>>[src]
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.
pub fn state(&self) -> State[src]
pub fn state(&self) -> StateReturns information about the current state of the pool.
pub fn max_size(&self) -> u32[src]
pub fn max_size(&self) -> u32Returns the configured maximum pool size.
pub fn min_idle(&self) -> Option<u32>[src]
pub fn min_idle(&self) -> Option<u32>Returns the configured mimimum idle connection count.
pub fn test_on_check_out(&self) -> bool[src]
pub fn test_on_check_out(&self) -> boolReturns if the pool is configured to test connections on check out.
pub fn max_lifetime(&self) -> Option<Duration>[src]
pub fn max_lifetime(&self) -> Option<Duration>Returns the configured maximum connection lifetime.
pub fn idle_timeout(&self) -> Option<Duration>[src]
pub fn idle_timeout(&self) -> Option<Duration>Returns the configured idle connection timeout.
pub fn connection_timeout(&self) -> Duration[src]
pub fn connection_timeout(&self) -> DurationReturns the configured connection timeout.
Trait Implementations
impl<M> Clone for Pool<M> where
M: ManageConnection, [src]
impl<M> Clone for Pool<M> where
M: ManageConnection, Returns a new Pool referencing the same state as self.
fn clone(&self) -> Pool<M>[src]
fn clone(&self) -> Pool<M>Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl<M> Debug for Pool<M> where
M: ManageConnection + Debug, [src]
impl<M> Debug for Pool<M> where
M: ManageConnection + Debug, Auto Trait Implementations
impl<M> Send for Pool<M> where
<M as ManageConnection>::Connection: Send,
impl<M> Send for Pool<M> where
<M as ManageConnection>::Connection: Send, impl<M> Sync for Pool<M> where
<M as ManageConnection>::Connection: Send,
impl<M> Sync for Pool<M> where
<M as ManageConnection>::Connection: Send,