Struct ConfigNode 

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

One loaded config source in a tree.

Type Parameters

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

Implementations

impl<T> ConfigNode<T>

Accessors for one loaded config tree node.

pub fn path(&self) -> &Path

Returns the normalized absolute source path.

Arguments

• self: Loaded config node being inspected.

Returns

Returns the normalized absolute source path.

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!(tree.nodes()[0].path().ends_with("root.yaml"));

pub fn value(&self) -> &T

Returns the loaded source value.

Arguments

• self: Loaded config node being inspected.

Returns

Returns a shared reference to the loaded source value.

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()[0].value(), &"root");

pub fn includes(&self) -> &[PathBuf]

Returns include paths declared by this source.

Arguments

• self: Loaded config node being inspected.

Returns

Returns the include paths declared by this source.

Examples

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

let tree = load_config_tree(
    "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.nodes()[0].includes(), &[PathBuf::from("child.yaml")]);

pub fn into_value(self) -> T

Decomposes the node into its loaded value.

Arguments

• self: Loaded config node to decompose.

Returns

Returns the loaded source value.

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()))
    },
)?;

let mut nodes = tree.into_nodes();
assert_eq!(nodes.remove(0).into_value(), "root");

Trait Implementations

impl<T: Clone> Clone for ConfigNode<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ConfigNode<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for ConfigNode<T>

fn eq(&self, other: &ConfigNode<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 ConfigNode<T>

impl<T> StructuralPartialEq for ConfigNode<T>