Struct scfg::Scfg

pub struct Scfg { /* fields omitted */ }

An scfg document. Implemented as a multimap.

If the preserve_order feature is enabled, the directive names will be kept in the order of their first appearance. Otherwise, they will be sorted by name.

Implementations

impl Scfg

pub fn new() -> Self

Creates a new empty document

pub fn get<Q: ?Sized>(&self, name: &Q) -> Option<&Directive> where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Retrieves the first directive with a particular name.

This will return None if either, the name is not found, or if the name somehow has no directives.

pub fn get_all<Q: ?Sized>(&self, name: &Q) -> Option<&[Directive]> where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Retrieves the all directives with a particular name.

pub fn get_all_mut<Q: ?Sized>(
    &mut self,
    name: &Q
) -> Option<&mut Vec<Directive>> where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Retrieves a mutable reference to all directives with a particular name.

pub fn contains<Q: ?Sized>(&self, name: &Q) -> bool where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Does the document contain a directive with name.

let mut scfg = Scfg::new();
scfg.add("foo");
assert!(scfg.contains("foo"));
assert!(!scfg.contains("bar"));

pub fn add(&mut self, name: impl Into<String>) -> &mut Directive

Adds a new name returning the new (empty) directive.

let mut scfg = Scfg::new();
let dir = scfg.add("dir1");
assert_eq!(*dir, Directive::default());

Note

This does not validate that name is a legal scfg word. It is possible to create unparsable documents should name contain control characters or newlines.

pub fn remove<Q: ?Sized>(&mut self, name: &Q) -> Option<Vec<Directive>> where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Removes all directives with the supplied name, returning them.

pub fn remove_entry<Q: ?Sized>(
    &mut self,
    name: &Q
) -> Option<(String, Vec<Directive>)> where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Removes all directives with the supplied name, returning them, and their key.

pub fn write<W>(&self, writer: &mut W) -> Result<()> where
    W: Write, 

Writes the document to the specified writer. If efficiency is a concern, it may be best to wrap the writer in a [BufWriter] first. This will not write any comments that the document had if it was parsed first.

Trait Implementations

impl Clone for Scfg

fn clone(&self) -> Scfg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scfg

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

Formats the value using the given formatter.

impl Default for Scfg

fn default() -> Scfg

Returns the "default value" for a type.

impl Eq for Scfg

impl<K: Into<String>> FromIterator<(K, Directive)> for Scfg

fn from_iter<T>(it: T) -> Self where
    T: IntoIterator<Item = (K, Directive)>, 

Creates a value from an iterator.

impl FromStr for Scfg

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl PartialEq<Scfg> for Scfg

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

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

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

This method tests for !=.

impl StructuralEq for Scfg

impl StructuralPartialEq for Scfg