Enum reool::CheckoutMode

pub enum CheckoutMode {
    Immediately,
    Wait,
    PoolDefault,
    Until(Instant),
}

Various options on retrieving a connection

Special From implementations

• Duration: Until with a deadline from now until the durations elapsed.
• Instant: Until the given instant.

Variants

Immediately

Expect a connection to be returned immediately. If there is none available return an error immediately. In that case a CheckoutErrorKind::NoConnection will be returned

This mode will always try to get a connection

Wait

Wait until there is a connection

Using this can be risky as connections are returned when dropped. If the pool has no idle connections left while none are returned a deadlock might occur. It is always safe to use this mode if only the RedisPool itself is used as a connection since it will immediately return the used connection after each operation.

PoolDefault

Use the default configured for the pool

Until(Instant)

Checkout before the given Instant is elapsed. If the given timeout is elapsed, no attempt to checkout a connection will be made. In that case a CheckoutErrorKind::CheckoutTimeout will be returned.

Implementations

impl CheckoutMode

pub fn is_deadline_elapsed(self) -> bool

Trait Implementations

impl Clone for CheckoutMode

fn clone(&self) -> CheckoutMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CheckoutMode

impl Debug for CheckoutMode

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

Formats the value using the given formatter.

impl Default for CheckoutMode

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CheckoutMode

impl From<Duration> for CheckoutMode

fn from(d: Duration) -> Self

Performs the conversion.

impl From<Immediately> for CheckoutMode

fn from(_: Immediately) -> Self

Performs the conversion.

impl From<Instant> for CheckoutMode

fn from(until: Instant) -> Self

Performs the conversion.

impl From<Millis> for CheckoutMode

fn from(d: Millis) -> Self

Performs the conversion.

impl From<PoolDefault> for CheckoutMode

fn from(_: PoolDefault) -> Self

Performs the conversion.

impl From<Seconds> for CheckoutMode

fn from(d: Seconds) -> Self

Performs the conversion.

impl From<Wait> for CheckoutMode

fn from(_: Wait) -> Self

Performs the conversion.

impl PartialEq<CheckoutMode> for CheckoutMode

fn eq(&self, other: &CheckoutMode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CheckoutMode) -> bool

This method tests for !=.

impl StructuralEq for CheckoutMode

impl StructuralPartialEq for CheckoutMode