Struct ConfigTree 

pub struct ConfigTree<T> { /* private fields */ }

A loaded config tree in traversal order.

Type Parameters

• T: Loaded source value type stored by each node.

Implementations

impl<T> ConfigTree<T>

Accessors for a loaded config tree.

pub fn nodes(&self) -> &[ConfigNode<T>]

Returns loaded tree nodes in traversal order.

Arguments

• self: Loaded config tree being inspected.

Returns

Returns loaded nodes in traversal order.

Examples

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

let tree = load_config_tree(
    "root.yaml",
    |_path: &Path| -> io::Result<ConfigSource<&'static str>> {
        Ok(ConfigSource::new("root", Vec::new()))
    },
)?;

assert_eq!(tree.nodes().len(), 1);

pub fn into_nodes(self) -> Vec<ConfigNode<T>>

Decomposes the tree into its nodes.

Arguments

• self: Loaded config tree to decompose.

Returns

Returns the loaded nodes, preserving traversal order.

Examples

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

let tree = load_config_tree(
    "root.yaml",
    |_path: &Path| -> io::Result<ConfigSource<&'static str>> {
        Ok(ConfigSource::new("root", Vec::new()))
    },
)?;

assert_eq!(tree.into_nodes().len(), 1);

pub fn into_values(self) -> Vec<T>

Decomposes the tree into loaded values, discarding paths and includes.

Arguments

• self: Loaded config tree to decompose.

Returns

Returns loaded source values in traversal order.

Examples

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

let tree = load_config_tree(
    "root.yaml",
    |_path: &Path| -> io::Result<ConfigSource<&'static str>> {
        Ok(ConfigSource::new("root", Vec::new()))
    },
)?;

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

Trait Implementations

impl<T: Clone> Clone for ConfigTree<T>

fn clone(&self) -> ConfigTree<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ConfigTree<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for ConfigTree<T>

fn eq(&self, other: &ConfigTree<T>) -> 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<T: Eq> Eq for ConfigTree<T>

impl<T> StructuralPartialEq for ConfigTree<T>