Struct Section 

pub struct Section<'a> { /* private fields */ }

One map of the tree, read under a dotted prefix.

Implementations

impl<'a> Section<'a>

pub fn root(node: Option<&'a Node>) -> Result<Self, ConfigError>

The root of a tree (None = nothing was loaded: every read is absent).

Errors

ConfigError::Invalid when the root is not a map.

pub fn of( node: Option<&'a Node>, prefix: impl Into<String>, ) -> Result<Self, ConfigError>

node as a section named prefix.

Errors

ConfigError::Invalid when node is not a map.

pub fn path_of(&self, key: &str) -> String

The dotted path of key in this section, for a caller’s own refusal.

pub fn node(&self, key: &str) -> Option<&'a Node>

The raw node at key.

pub fn only(&self, allowed: &[&str]) -> Result<(), ConfigError>

Refuses every key that allowed does not name.

Errors

ConfigError::Invalid for the first unknown key, with its origin.

pub fn section(&self, key: &str) -> Result<Section<'a>, ConfigError>

The nested section at key.

Errors

ConfigError::Invalid when it is not a map.

pub fn scalar( &self, key: &str, ) -> Result<Option<(&'a str, &'a Origin)>, ConfigError>

The scalar at key and where it came from.

Errors

ConfigError::Invalid when key holds a list or a map.

pub fn string(&self, key: &str) -> Result<Option<String>, ConfigError>

The text at key.

Errors

As Self::scalar.

pub fn parse<T: FromStr>( &self, key: &str, expect: &str, ) -> Result<Option<T>, ConfigError>

The value at key, parsed; expect says what the setting accepts.

Errors

As Self::scalar, and ConfigError::Invalid when it does not parse.

pub fn boolean(&self, key: &str) -> Result<Option<bool>, ConfigError>

true/false (or 1/0) at key.

Errors

ConfigError::Invalid for any other spelling.

pub fn choice( &self, key: &str, choices: &[&str], ) -> Result<Option<String>, ConfigError>

One of choices at key.

Errors

ConfigError::Invalid for anything else.

pub fn strings(&self, key: &str) -> Result<Option<Vec<String>>, ConfigError>

A list of texts at key: a sequence of scalars, or one scalar as a list of one.

Errors

ConfigError::Invalid for a map or a sequence holding one.

pub fn items(&self, key: &str) -> Result<Vec<(String, &'a Node)>, ConfigError>

The items of the sequence at key, each with its dotted path.

Errors

ConfigError::Invalid when key is not a sequence.

Trait Implementations

impl<'a> Clone for Section<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Section<'a>

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

Formats the value using the given formatter.