Struct Directive

pub struct Directive { /* private fields */ }

A single scfg directive, containing any number of parameters, and possibly one child block.

Implementations

impl Directive

pub fn new() -> Self

Creates a new empty directive.

pub fn params(&self) -> &[String]

Get this directive’s parameters

pub fn take_params(&mut self) -> Vec<String>

Take this directive’s parameters, leaving it empty.

pub fn append_param(&mut self, param: impl Into<String>) -> &mut Self

Appends the supplied parameter. Returns &mut self to support method chaining.

Note

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

pub fn clear_params(&mut self)

Clears all parameters from this directive.

pub fn child(&self) -> Option<&Scfg>

Get this directive’s child, if there is one.

pub fn take_child(&mut self) -> Option<Scfg>

Takes this directive’s child, leaving it with None.

pub fn get_or_create_child(&mut self) -> &mut Scfg

Returns the child, optionally creating it if it does not exist.

let mut directive = Directive::new();
assert!(directive.child().is_none());
directive.get_or_create_child();
assert!(directive.child().is_some());

Trait Implementations

impl Clone for Directive

fn clone(&self) -> Directive

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Directive

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

Formats the value using the given formatter.

impl Default for Directive

fn default() -> Directive

Returns the “default value” for a type.

impl PartialEq for Directive

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

impl StructuralPartialEq for Directive