config: add doc comment to AnnotatedValue

This commit is contained in:
Yuya Nishihara 2024-11-24 16:40:18 +09:00
parent 0b23bbb3bb
commit 14798d3f50

View file

@ -87,11 +87,16 @@ pub enum ConfigEnvError {
ConfigCreateError(#[from] std::io::Error),
}
/// Configuration variable with its source information.
#[derive(Clone, Debug, PartialEq)]
pub struct AnnotatedValue {
/// Dotted name path to the configuration variable.
pub path: ConfigNamePathBuf,
/// Configuration value.
pub value: config::Value,
/// Source of the configuration value.
pub source: ConfigSource,
/// True if this value is overridden in higher precedence layers.
pub is_overridden: bool,
}