Struct deadpool::managed::Pool[−][src]

pub struct Pool<M: Manager, W: From<Object<M>> = Object<M>> { /* fields omitted */ }
Expand description

A generic object and connection pool.

This struct can be cloned and transferred across thread boundaries and uses reference counting for its internal state.

Implementations

impl<M: Manager, W: From<Object<M>>> Pool<M, W>[src]

pub fn new(manager: M, max_size: usize) -> Pool<M, W>[src]

Create new connection pool with a given manager and max_size. The manager is used to create and recycle objects and max_size is the maximum number of objects ever created.

pub fn from_config(manager: M, config: PoolConfig) -> Pool<M, W>[src]

Create new connection pool with a given manager and config. The manager is used to create and recycle objects. The config specifies the maximum numbers of objects to be created and timeouts.

pub async fn get(&self) -> Result<W, PoolError<M::Error>>[src]

Retrieve object from pool or wait for one to become available.

pub async fn try_get(&self) -> Result<W, PoolError<M::Error>>[src]

Retrieve object from the pool and do not wait if there is currently no object available and the maximum pool size has been reached.

pub async fn timeout_get(
    &self,
    timeouts: &Timeouts
) -> Result<W, PoolError<M::Error>>[src]

Retrieve object using a different timeout config than the one configured.

pub fn close(&self)[src]

Close the pool

All current and future tasks waiting for objects return Err(PoolError::Closed) immediately.

pub fn is_closed(&self) -> bool[src]

Returns true if the pool has been closed

pub fn status(&self) -> Status[src]

Retrieve status of the pool

pub fn manager(&self) -> &M[src]

Get manager of the pool

Trait Implementations

impl<M: Manager, W: From<Object<M>>> Clone for Pool<M, W>[src]

fn clone(&self) -> Pool<M, W>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl<M, W = Object<M>> !RefUnwindSafe for Pool<M, W>

impl<M, W> Send for Pool<M, W> where
    M: Send + Sync,
    W: Send,
    <M as Manager>::Type: Send, 

impl<M, W> Sync for Pool<M, W> where
    M: Send + Sync,
    W: Sync,
    <M as Manager>::Type: Send, 

impl<M, W> Unpin for Pool<M, W> where
    W: Unpin, 

impl<M, W = Object<M>> !UnwindSafe for Pool<M, W>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.