Struct Config 

pub struct Config { /* private fields */ }

Top-level configuration value: a single named ConfPool.

The YAML document mirrors the C reference: a top-level mapping with exactly one key, the pool name, whose value is the pool body.

Implementations

impl Config

pub fn parse_str(input: &str) -> Result<Self, ConfError>

Parse a YAML configuration document from a string.

Performs structural validation (exactly one pool, no unknown keys) but does not apply defaults. Call Config::finalize before Config::validate to fully prepare the config.

Examples

use dynomite::conf::Config;
let yaml = "p:\n  listen: 127.0.0.1:1\n  dyn_listen: 127.0.0.1:2\n  tokens: '1'\n  servers:\n  - 127.0.0.1:3:1\n  data_store: 0\n";
let cfg = Config::parse_str(yaml).unwrap();
assert_eq!(cfg.pool_name(), "p");
assert!(Config::parse_str("").is_err());

pub fn parse_file(path: &Path) -> Result<Self, ConfError>

Parse a YAML configuration document from a filesystem path.

Examples

use std::io::Write;
use dynomite::conf::Config;
let mut f = tempfile::NamedTempFile::new().unwrap();
writeln!(f, "p:\n  listen: 127.0.0.1:1\n  dyn_listen: 127.0.0.1:2\n  tokens: '1'\n  servers:\n  - 127.0.0.1:3:1\n  data_store: 0\n").unwrap();
let cfg = Config::parse_file(f.path()).unwrap();
assert_eq!(cfg.pool_name(), "p");

pub fn pool_name(&self) -> &str

The configured pool name (the single top-level YAML key).

Examples

use dynomite::conf::Config;
let cfg = Config::parse_str("my_pool:\n  listen: 127.0.0.1:1\n  dyn_listen: 127.0.0.1:2\n  tokens: '1'\n  servers:\n  - 127.0.0.1:3:1\n  data_store: 0\n").unwrap();
assert_eq!(cfg.pool_name(), "my_pool");

pub fn pool(&self) -> &ConfPool

Borrow the inner ConfPool.

Examples

use dynomite::conf::Config;
let cfg = Config::parse_str("p:\n  listen: 127.0.0.1:8102\n  dyn_listen: 127.0.0.1:2\n  tokens: '1'\n  servers:\n  - 127.0.0.1:3:1\n  data_store: 0\n").unwrap();
assert_eq!(cfg.pool().listen.as_ref().unwrap().port(), 8102);

pub fn pool_mut(&mut self) -> &mut ConfPool

Mutably borrow the inner ConfPool.

Examples

use dynomite::conf::Config;
let mut cfg = Config::parse_str("p:\n  listen: 127.0.0.1:1\n  dyn_listen: 127.0.0.1:2\n  tokens: '1'\n  servers:\n  - 127.0.0.1:3:1\n  data_store: 0\n").unwrap();
cfg.pool_mut().preconnect = Some(true);
assert_eq!(cfg.pool().preconnect, Some(true));

pub fn finalize(&mut self)

Apply default values to any field left unset by the YAML.

Examples

use dynomite::conf::Config;
let mut cfg = Config::parse_str("p:\n  listen: 127.0.0.1:1\n  dyn_listen: 127.0.0.1:2\n  tokens: '1'\n  servers:\n  - 127.0.0.1:3:1\n  data_store: 0\n").unwrap();
assert!(cfg.pool().rack.is_none());
cfg.finalize();
assert!(cfg.pool().rack.is_some());

pub fn validate(&self) -> Result<(), ConfError>

Run the full validation pass.

Examples

use dynomite::conf::Config;
let mut cfg = Config::parse_str("p:\n  listen: 127.0.0.1:1\n  dyn_listen: 127.0.0.1:2\n  tokens: '1'\n  servers:\n  - 127.0.0.1:3:1\n  data_store: 0\n").unwrap();
cfg.finalize();
cfg.validate().unwrap();

pub fn test_conf(&self) -> Result<String, ConfError>

Equivalent of dynomite -t -c <file>: finalize, validate, and produce a short status string.

Examples

use dynomite::conf::Config;
let cfg = Config::parse_str("p:\n  listen: 127.0.0.1:1\n  dyn_listen: 127.0.0.1:2\n  tokens: '1'\n  servers:\n  - 127.0.0.1:3:1\n  data_store: 0\n").unwrap();
assert!(cfg.test_conf().unwrap().contains("is valid"));

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

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.