Struct RedisConfigOptions

pub struct RedisConfigOptions {
    pub max_connections: u32,
    pub idle_timeout: u64,
    pub create_timeout: Option<u64>,
    pub recycle_timeout: Option<u64>,
    pub wait_timeout: Option<u64>,
    pub recycle_check_frequency: usize,
}

Additional configuration options for a redis client.

Fields

max_connections: u32

Maximum number of connections managed by the pool.

idle_timeout: u64

Sets the idle timeout used by the pool, in seconds.

The idle timeout defines the maximum time a connection will be kept in the pool if unused.

create_timeout: Option<u64>

Sets the maximum time in seconds to wait when establishing a new Redis connection.

If a connection cannot be established within this duration, it is considered a failure. Applies when the pool needs to grow or create fresh connections.

recycle_timeout: Option<u64>

Sets the maximum time in seconds to validate an existing connection when it is recycled.

Recycling involves checking whether an idle connection is still alive before reuse. If validation exceeds this timeout, the connection is discarded and a new fetch from the pool is attempted.

wait_timeout: Option<u64>

Sets the maximum time, in seconds, that a caller is allowed to wait when requesting a connection from the pool.

If a connection does not become available within this period, the attempt will fail with a timeout error. This setting helps prevent indefinite blocking when the pool is exhausted.

recycle_check_frequency: usize

Sets the number of times after which the connection will check whether it is active when being recycled.

A frequency of 1, means that the connection will check whether it is active every time it is recycled.

Trait Implementations

impl Clone for RedisConfigOptions

fn clone(&self) -> RedisConfigOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RedisConfigOptions

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

Formats the value using the given formatter.

impl Default for RedisConfigOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RedisConfigOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RedisConfigOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RedisConfigOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RedisConfigOptions

impl StructuralPartialEq for RedisConfigOptions