Struct bml::BmlNode

pub struct BmlNode { /* fields omitted */ }

BML node comprising data lines() and child nodes().

By design, attributes are considered child nodes as well but carry a flag marking them as attributes for serialization purpose only.

Methods

impl BmlNode

pub fn value(&self) -> &str

Value comprising data lines with '\n' removed from last line.

pub fn lines(&self) -> impl DoubleEndedIterator<Item = &str>

Iterator over data lines.

pub fn nodes(
    &self
) -> impl DoubleEndedIterator<Item = (&str, &BmlNode)> + ExactSizeIterator

Iterator over child nodes as (name, node) tuples.

pub fn named(&self, name: &str) -> impl DoubleEndedIterator<Item = &BmlNode>

Iterator over child nodes of name.

NOTE: Fallback implementation for stable Rust using Vec instead of ordered_multimap::ListOrderedMultimap. On nightly Rust enable the ordered-multimap feature to reduce the complexity to O(m) where m is the number of nodes matching name.

Complexity: O(n) where n is the total number of child nodes.

pub fn set_indent(&mut self, string: &'static str, repeat: usize)

Indent string of child nodes and level as repeat times string.

Default is two spaces as in " " and no root indent (0). Usual alternative is a tabulator as in "\t" and no root indent (0).

Trait Implementations

impl PartialEq<BmlNode> for BmlNode

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

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

#[must_use]

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

This method tests for !=.

impl Default for BmlNode

fn default() -> BmlNode

Returns the "default value" for a type.

impl Clone for BmlNode

fn clone(&self) -> BmlNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for BmlNode

impl Display for BmlNode

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

Formats the value using the given formatter.

impl Debug for BmlNode

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

Formats the value using the given formatter.

impl<'_> TryFrom<&'_ str> for BmlNode

type Error = BmlError

The type returned in the event of a conversion error.

fn try_from(bml: &str) -> Result<Self, Self::Error>

Performs the conversion.