Struct Config 

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

Configuration object.

Example (from environment)

You can read the configuration using the config crate as following:

MEMCACHED__ADDR=127.0.0.1:11211
MEMCACHED__POOL__MAX_SIZE=16
MEMCACHED__POOL__TIMEOUTS__WAIT__SECS=5
MEMCACHED__POOL__TIMEOUTS__WAIT__NANOS=0

#[derive(serde::Deserialize, serde::Serialize)]
struct Config {
    memcached: deadpool_memcached::Config,
}
impl Config {
    pub fn from_env() -> Result<Self, config::ConfigError> {
        let mut cfg = config::Config::builder()
           .add_source(config::Environment::default().separator("__"))
           .build()?;
           cfg.try_deserialize()
    }
}

Fields

addr: Option<String>

Memcached address.

pool: Option<PoolConfig>

Pool configuration.

Implementations

impl Config

pub fn new(addr: impl Into<String>) -> Self

Creates a new Config with the given Memcached address.

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

Creates a new Pool using this Config.

A Runtime is required if any Timeouts are configured on the PoolConfig (wait, create or recycle). Pass None if you do not need timeouts.

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_addr(&self) -> &str

Returns address used to connect to the Memcached server.

pub fn get_pool_config(&self) -> PoolConfig

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

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate 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.