Struct Config

pub struct Config {
    pub urls: Option<Vec<String>>,
    pub server_type: SentinelServerType,
    pub master_name: String,
    pub connections: Option<Vec<ConnectionInfo>>,
    pub node_connection_info: Option<SentinelNodeConnectionInfo>,
    pub pool: Option<PoolConfig>,
}

Configuration object.

Example (from environment)

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

REDIS_SENTINEL__URLS=redis://127.0.0.1:26379,redis://127.0.0.1:26380
REDIS_SENTINEL__MASTER_NAME=mymaster
REDIS_SENTINEL__SERVER_TYPE=master
REDIS_SENTINEL__POOL__MAX_SIZE=16
REDIS_SENTINEL__POOL__TIMEOUTS__WAIT__SECS=2
REDIS_SENTINEL__POOL__TIMEOUTS__WAIT__NANOS=0

#[derive(serde::Deserialize)]
struct Config {
    redis_sentinel: deadpool_redis::sentinel::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.

server_type: SentinelServerType

ServerType

SentinelServerType

master_name: String

Sentinel setup master name. default value is mymaster

connections: Option<Vec<ConnectionInfo>>

redis::ConnectionInfo structures.

node_connection_info: Option<SentinelNodeConnectionInfo>

redis::sentinel::SentinelNodeConnectionInfo structures.

pool: Option<PoolConfig>

Pool configuration.

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, master_name: String, server_type: SentinelServerType, ) -> Config

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

pub fn with_node_connection_info( self, node_connection_info: Option<SentinelNodeConnectionInfo>, ) -> Self

Sets the connection info used to connect to the underlying redis servers (eg: tls mode/db/username/..)

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.