Struct ConfigTreeOptions 

pub struct ConfigTreeOptions { /* private fields */ }

Options for loading a recursive config tree.

Use this type when the default traversal behavior is not enough, for example when sibling includes should be visited in reverse declaration order.

Implementations

impl ConfigTreeOptions

Builder-style configuration for include tree traversal.

pub fn include_order(self, include_order: IncludeOrder) -> Self

Sets the sibling include traversal order.

Arguments

• include_order: Order used when visiting sibling include paths.

Returns

Returns the updated options value.

Examples

use rust_config_tree::{ConfigTreeOptions, IncludeOrder};

let options = ConfigTreeOptions::default().include_order(IncludeOrder::Reverse);

pub fn load<T, E, F>( &self, root_path: impl AsRef<Path>, load: F, ) -> Result<ConfigTree<T>>

where E: Into<BoxError>, F: FnMut(&Path) -> Result<ConfigSource<T>, E>,

Loads a config tree from root_path with a custom source loader.

The loader returns both the source value and the include paths declared by that source. Relative include paths are resolved from the source path.

Type Parameters

• T: Loaded value type stored for each config source.
• E: Error type returned by load.
• F: Source loader callback type.

Arguments

• root_path: Root config path to load first.
• load: Callback that receives each normalized absolute source path and returns the source value with its declared include paths.

Returns

Returns a ConfigTree containing loaded nodes in traversal order.

Examples

use std::{io, path::{Path, PathBuf}};
use rust_config_tree::{ConfigSource, ConfigTreeOptions};

let tree = ConfigTreeOptions::default().load(
    "root.yaml",
    |path: &Path| -> io::Result<ConfigSource<&'static str>> {
        if path.ends_with("root.yaml") {
            Ok(ConfigSource::new("root", vec![PathBuf::from("child.yaml")]))
        } else {
            Ok(ConfigSource::new("child", Vec::new()))
        }
    },
)?;

assert_eq!(tree.into_values(), vec!["root", "child"]);

Trait Implementations

impl Clone for ConfigTreeOptions

fn clone(&self) -> ConfigTreeOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigTreeOptions

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

Formats the value using the given formatter.

impl Default for ConfigTreeOptions

fn default() -> ConfigTreeOptions

Returns the “default value” for a type.

impl PartialEq for ConfigTreeOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ConfigTreeOptions

impl Eq for ConfigTreeOptions

impl StructuralPartialEq for ConfigTreeOptions