Enum ConfError 

pub enum ConfError {
    Io {
        path: PathBuf,
        source: Error,
    },
    EmptyDocument,
    TooManyPools(usize),
    EmptyPoolName,
    UnknownKey {
        name: String,
    },
    MissingRequired(&'static str),
    BadAddr {
        field: &'static str,
        value: String,
        reason: String,
    },
    BadToken {
        value: String,
        reason: String,
    },
    BadConsistency {
        field: &'static str,
        value: String,
    },
    BadSecure(String),
    BadDataStore(i64),
    BadNoxuConfig(&'static str),
    BadHash(String),
    BadDistribution(String),
    OutOfRange {
        field: &'static str,
        value: i64,
        reason: &'static str,
    },
    BadServer {
        field: &'static str,
        value: String,
        reason: String,
    },
    BadHashTag(String),
    Yaml {
        message: String,
    },
}

Errors that can occur while loading or validating a Config.

Examples

use dynomite::conf::{Config, ConfError};
let err = Config::parse_str("").unwrap_err();
assert!(matches!(err, ConfError::Yaml { .. } | ConfError::EmptyDocument));

Variants

Io

I/O error while reading a configuration file.

Fields

path: PathBuf

The path that triggered the failure.

source: Error

The underlying I/O error.

EmptyDocument

The YAML document was empty or missing the top-level pool.

TooManyPools(usize)

The top-level mapping had more than one pool.

EmptyPoolName

The top-level pool name was the empty string.

UnknownKey

A directive name in the YAML is not recognized.

Fields

name: String

The unrecognized YAML key.

MissingRequired(&'static str)

A required directive is absent from the configuration.

BadAddr

listen / dyn_listen / stats_listen address could not be parsed.

Fields

field: &'static str

The directive whose value failed to parse.

value: String

The string that failed to parse.

reason: String

Human-readable parse failure reason.

BadToken

A token list could not be parsed as comma-separated big-ints.

Fields

value: String

The token-list string.

reason: String

Human-readable parse failure reason.

BadConsistency

read_consistency / write_consistency value is not a known level.

Fields

field: &'static str

The directive: read_consistency or write_consistency.

value: String

The unrecognized value.

BadSecure(String)

secure_server_option value is not a known mode.

BadDataStore(i64)

data_store value is not 0 (Redis), 1 (Memcache), or 2 (Noxu). The string forms redis, memcache, and noxu are also accepted on the YAML side and are translated to these integers before validation.

BadNoxuConfig(&'static str)

data_store: noxu was selected but noxu_path was not supplied or dynomited was built without --features riak.

BadHash(String)

hash value is not a recognized hash algorithm name.

BadDistribution(String)

distribution value is not a recognized distribution algorithm name.

OutOfRange

A numeric directive is out of its allowed range.

Fields

field: &'static str

The directive name.

value: i64

The offending value.

reason: &'static str

What range was expected.

BadServer

A server / dyn_seeds entry is malformed.

Fields

field: &'static str

The directive (servers or dyn_seeds).

value: String

The malformed entry.

reason: String

Human-readable failure reason.

BadHashTag(String)

hash_tag must be exactly two characters, per the C parser.

Yaml

The YAML failed to parse at the document level.

Fields

message: String

The YAML error message (with location, if available).

Trait Implementations

impl Debug for ConfError

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

Formats the value using the given formatter.

impl Display for ConfError

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

Formats the value using the given formatter.

impl Error for ConfError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<ConfError> for EmbedError

fn from(source: ConfError) -> Self

Converts to this type from the input type.