Struct RedisConfig

pub struct RedisConfig {
    pub connection_url: Option<String>,
    pub host: Option<String>,
    pub port: Option<u16>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub db: Option<u64>,
    pub connection_timeout: Duration,
    pub connection_pool_size: u32,
}

RedisConfig represents the configuration for connecting to a Redis instance.

This configuration object is used to set up a connection pool to Redis, providing necessary details such as the Redis host, port, authentication credentials, and pool settings.

In more advanced setups, such as Redis clusters or socket connections, the connection_url field can be used to provide a direct connection string. If connection_url is provided, fields like host, port, and db become optional.

Configuration fields can be loaded from various sources, such as YAML, JSON configuration files, or from environment variables.

Example configuration in YAML:

host: localhost
port: 6379
username: username
password: top_secret_password
db: 0
connection_timeout:
  secs: 60
  nanos: 0
connection_pool_size: 10

Another example configuration in YAML:

connection_url: "redis://username:password@localhost:6379/0"
connection_timeout:
  secs: 60
  nanos: 0
connection_pool_size: 10

Fields like connection_timeout and connection_pool_size control how the connection pool behaves.

Fields

connection_url: Option<String>

Optional direct connection URL (useful for Redis clusters or socket connections). If connection_url is specified, the host, port, and db fields become optional and are not used.

host: Option<String>

The Redis server host address (e.g., localhost).

port: Option<u16>

The port to connect to the Redis server (e.g., 6379 for Redis).

username: Option<String>

The optional username to authenticate with Redis (mostly used in Redis 6+ with ACLs).

password: Option<String>

The optional password to authenticate with Redis.

db: Option<u64>

The database number to connect to (default is 0).

connection_timeout: Duration

The timeout duration for establishing a connection to the Redis server.

connection_pool_size: u32

The maximum number of connections allowed in the pool.

Implementations

impl RedisConfig

pub fn check(&self) -> Result<()>

Checks the validity of the configuration.

If connection_url is provided, the configuration is considered valid. Otherwise, host, port, and db must be provided for a valid configuration.

Returns

Ok(()) if the configuration is valid, or an anyhow::Error explaining the missing fields.

Trait Implementations

impl Debug for RedisConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RedisConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RedisConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.