Struct deadpool_redis::cluster::Config

pub struct Config {
    pub urls: Option<Vec<String>>,
    pub connections: Option<Vec<ConnectionInfo>>,
    pub pool: Option<PoolConfig>,
    pub read_from_replicas: bool,
}

Configuration object.

Example (from environment)

By enabling the serde feature you can read the configuration using the config crate as following:

REDIS_CLUSTER__URLS=redis://127.0.0.1:7000,redis://127.0.0.1:7001
REDIS_CLUSTER__READ_FROM_REPLICAS=true
REDIS_CLUSTER__POOL__MAX_SIZE=16
REDIS_CLUSTER__POOL__TIMEOUTS__WAIT__SECS=2
REDIS_CLUSTER__POOL__TIMEOUTS__WAIT__NANOS=0

#[derive(serde::Deserialize)]
struct Config {
    redis_cluster: deadpool_redis::cluster::Config,
}

impl Config {
    pub fn from_env() -> Result<Self, config::ConfigError> {
        let mut cfg = config::Config::builder()
           .add_source(
               config::Environment::default()
               .separator("__")
               .try_parsing(true)
               .list_separator(","),
           )
           .build()?;
           cfg.try_deserialize()
    }
}

Fields

urls: Option<Vec<String>>

Redis URLs.

See Connection Parameters.

connections: Option<Vec<ConnectionInfo>>

redis::ConnectionInfo structures.

pool: Option<PoolConfig>

Pool configuration.

read_from_replicas: bool

Enables or disables reading from replica nodes in a Redis cluster.

When set to true, read operations may be distributed across replica nodes, which can help in load balancing read requests. When set to false, all read operations will be directed to the master node(s). This option is particularly useful in a high-availability setup where read scalability is needed.

Default is false.

Implementations

impl Config

pub fn create_pool( &self, runtime: Option<Runtime>, ) -> Result<Pool, CreatePoolError>

Creates a new Pool using this Config.

Errors

See CreatePoolError for details.

pub fn builder(&self) -> Result<PoolBuilder, ConfigError>

Creates a new PoolBuilder using this Config.

Errors

See ConfigError for details.

pub fn get_pool_config(&self) -> PoolConfig

Returns deadpool::managed::PoolConfig which can be used to construct a deadpool::managed::Pool instance.

pub fn from_urls<T: Into<Vec<String>>>(urls: T) -> Config

Creates a new Config from the given Redis URL (like redis://127.0.0.1).

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.