Struct confindent::Confindent

pub struct Confindent { /* fields omitted */ }

Structure for Reading/Writing configuration

Methods

impl Confindent

pub fn new() -> Self

Create an empty configuration

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Creates a new configuration from a file

Examples

use confindent::Confindent;

let conf = Confindent::from_file("./examples/example.conf");

pub fn to_file<P: AsRef<Path>>(self, path: P) -> Result<()>

Writes configurtion to a file

Examples

use confindent::{Confindent, ConfParent};

let mut conf = Confindent::new();
conf.create("Section", "Value");
conf.child_mut("Section")
    .unwrap()
    .create("SubSection", "Value")
    .create("SubSection", "Value");

conf.to_file("example.conf").unwrap();

Trait Implementations

impl ConfParent for Confindent

fn get_child<T: Into<String>>(&self, key: T) -> Option<&ConfSection>

Get a reference to a child section

fn get_child_mut<T: Into<String>>(&mut self, key: T) -> Option<&mut ConfSection>

Get a mutable reference to a child section

fn create_child<T: Into<String>>(&mut self, key: T, value: T) -> &mut Self

Create a child section

fn child<T: Into<String>>(&self, key: T) -> Option<&ConfSection>

Shorthand for get_child()

fn child_mut<T: Into<String>>(&mut self, key: T) -> Option<&mut ConfSection>

Shorthand for get_child_mut()

fn create<T: Into<String>>(&mut self, key: T, value: T) -> &mut Self

Shorthand for create_child()

fn get_child_value<T: Into<String>, Y: FromStr>(&self, key: T) -> Option<Y>

Get the value of a child

fn child_value<T: Into<String>, Y: FromStr>(&self, key: T) -> Option<Y>

Shorthand for get_child_value()

impl Into<String> for Confindent

fn into(self) -> String

Performs the conversion.

impl PartialEq<Confindent> for Confindent

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

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

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

This method tests for !=.

impl Debug for Confindent

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

Formats the value using the given formatter.

impl FromStr for Confindent

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.