Struct nccl::config::Config

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

A nccl configuration

Indexable with &str.

e.g.

// config.nccl:
// server
//     domain
//         example.com
//         www.example.com
//     port
//         80
//         443
//     root
//         /var/www/html

let content = std::fs::read_to_string("examples/config.nccl").unwrap();
let config = parse_config(&content).unwrap();

// get the value of a single node
assert_eq!(Some("/var/www/html"), config["server"]["root"].value());

// value always returns the value of the first child node
assert_eq!(Some("example.com"), config["server"]["domain"].value());

// get multiple values
assert_eq!(
    vec!["example.com", "www.example.com"],
    config["server"]["domain"].values().collect::<Vec<_>>()
);

// parse multiple values
assert_eq!(
    Ok(vec![80, 443]),
    config["server"]["port"]
        .values()
        .map(|value| value.parse::<u16>())
        .collect::<Result<Vec<_>, _>>()
);

Implementations

impl<'a> Config<'a>

pub fn quoted(&self) -> bool

pub fn quote_kind(&self) -> Option<QuoteKind>

pub fn has_value(&self, value: &str) -> bool

Check whether the config has the node.

pub fn children(&self) -> impl Iterator<Item = &Config<'a>>

Iterator for the children of a node.

pub fn child(&self) -> Option<&Config<'a>>

The first child of the node.

// excerpt of long.nccl:
// strings
//    in which case
//       "just\nuse quotes"
let source = std::fs::read_to_string("examples/long.nccl").unwrap();
let config = parse_config(&source).unwrap();
assert_eq!(
    "just\nuse quotes",
    config["strings"]["in which case:"]
        .child()
        .unwrap()
        .parse_quoted()
        .unwrap()
);

pub fn key(&self) -> &'a str

The key of the config node.

let source = "key\n value\n";
let config = nccl::parse_config(&source).unwrap();
assert_eq!(config["key"].key(), "key");

pub fn span(&self) -> Span

The location in the source of this node.

let source = "key\n value\n";
let config = nccl::parse_config(&source).unwrap();
assert_eq!(config["key"].span().line, 1);
assert_eq!(config["key"].child().unwrap().span().line, 2);

pub fn values(&self) -> impl Iterator<Item = &str>

Iterator for the child values of a node.

pub fn value(&self) -> Option<&'a str>

The first child value of a node.

pub fn parse_quoted(&self) -> Result<String, NcclError>

Parse the string including escape sequences if it’s quoted.

Operates on the first child of the node. See Config::child.

Trait Implementations

impl<'a> Clone for Config<'a>

fn clone(&self) -> Config<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Config<'a>

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

Formats the value using the given formatter.

impl Hash for Config<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Index<&str> for Config<'a>

type Output = Config<'a>

The returned type after indexing.

fn index(&self, index: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl PartialEq for Config<'_>

fn eq(&self, rhs: &Config<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl ToString for Config<'_>

fn to_string(&self) -> String

Converts the given value to a String.

impl<'a> Eq for Config<'a>