Struct ConfigProblem 

#[non_exhaustive]
pub struct ConfigProblem { /* private fields */ }

One configuration problem: its ProblemKind, the settings it names, and the human-readable sentence.

kind and keys are what a caller matches on; message (also its Display) is for people, and its wording may change in any release. #[non_exhaustive].

An application loader mixes its own problems in with ConfigProblem::from(String) (kind ProblemKind::Other) or ConfigProblem::new.

Implementations

impl ConfigProblem

pub fn new( kind: ProblemKind, keys: impl IntoIterator<Item = impl Into<String>>, message: impl Into<String>, ) -> Self

A problem of kind naming keys (already spelled the way the error’s KeyNaming spells them), described by message.

pub fn kind(&self) -> ProblemKind

What kind of problem this is.

pub fn keys(&self) -> &[String]

The settings this problem names, rendered via KeyNaming (a dotted key or an environment variable). Empty for a problem converted from a String.

pub fn message(&self) -> &str

The human-readable sentence. Not a stable API: match on kind instead.

Trait Implementations

impl Clone for ConfigProblem

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 ConfigProblem

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

Formats the value using the given formatter.

impl Display for ConfigProblem

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

Formats the value using the given formatter.

impl Eq for ConfigProblem

impl From<String> for ConfigProblem

fn from(message: String) -> Self

A problem of kind ProblemKind::Other with no keys.

impl PartialEq for ConfigProblem

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ConfigProblem