Struct deadpool_redis::Config

pub struct Config {
    pub url: Option<String>,
    pub pool: Option<PoolConfig>,
}

Configuration object. By enabling the config feature you can read the configuration using the config crate.

Example environment

REDIS__URL=pg.example.com
REDIS__POOL__MAX_SIZE=16
REDIS__POOL__TIMEOUTS__WAIT__SECS=2
REDIS__POOL__TIMEOUTS__WAIT__NANOS=0

Example usage

struct Config {
    redis: deadpool_postgres::Config,
}
impl Config {
    pub fn from_env() -> Result<Self, config::ConfigError> {
        let mut cfg = config::Config::new();
        cfg.merge(config::Environment::new().separator("__")).unwrap();
        cfg.try_into().unwrap()
    }
}

Fields

url: Option<String>

Redis URL See https://docs.rs/redis/0.15.1/redis/#connection-parameters

pool: Option<PoolConfig>

Pool configuration

Implementations

impl Config

pub fn from_env(prefix: &str) -> Result<Self, ConfigError>

Create configuration from environment variables.

pub fn create_pool(&self) -> RedisResult<Pool>

Create pool using the current configuration

pub fn get_url(&self) -> &str

Get URL which can be used to connect to the database.

pub fn get_pool_config(&self) -> PoolConfig

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

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.