Enum reool::config::DefaultPoolCheckoutMode

pub enum DefaultPoolCheckoutMode {
    Immediately,
    Wait,
    WaitAtMost(Duration),
}

Various options on retrieving a connection that can be applied if a user wants to use the pool defaults for retrieving a connection.

The default is to wait for 30ms.

This struct only slightly differs from CheckoutMode: It lacks the variant PoolDefault since that variant would make no sense as this enum describes the default behaviour of the pool.

This struct has the same behaviour as CheckoutMode regarding its From implementations.

The default is to wait for 30ms.

Variants

Immediately

Expect a connection to be returned immediately. If there is none available return an error immediately.

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.

WaitAtMost(Duration)

Wait for at most the given Duration.

The amount of time waited will in the end not be really exact.

Trait Implementations

impl Clone for DefaultPoolCheckoutMode

fn clone(&self) -> DefaultPoolCheckoutMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DefaultPoolCheckoutMode

impl Debug for DefaultPoolCheckoutMode

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

Formats the value using the given formatter.

impl Default for DefaultPoolCheckoutMode

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DefaultPoolCheckoutMode

impl From<Duration> for DefaultPoolCheckoutMode

fn from(d: Duration) -> Self

Performs the conversion.

impl From<Immediately> for DefaultPoolCheckoutMode

fn from(_: Immediately) -> Self

Performs the conversion.

impl From<Millis> for DefaultPoolCheckoutMode

fn from(d: Millis) -> Self

Performs the conversion.

impl From<Seconds> for DefaultPoolCheckoutMode

fn from(d: Seconds) -> Self

Performs the conversion.

impl From<Wait> for DefaultPoolCheckoutMode

fn from(_: Wait) -> Self

Performs the conversion.

impl FromStr for DefaultPoolCheckoutMode

type Err = ParseDefaultPoolCheckoutModeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<DefaultPoolCheckoutMode> for DefaultPoolCheckoutMode

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

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

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

This method tests for !=.

impl StructuralEq for DefaultPoolCheckoutMode

impl StructuralPartialEq for DefaultPoolCheckoutMode