Enum Item

pub enum Item<'a> {
    Error(&'a str),
    Section {
        name: &'a str,
        raw: &'a str,
    },
    SectionEnd,
    Property {
        key: &'a str,
        val: Option<&'a str>,
        raw: &'a str,
    },
    Comment {
        raw: &'a str,
    },
    Blank {
        raw: &'a str,
    },
}

A parsed element of syntatic meaning

Variants

Error(&'a str)

Syntax error.

Section header element was malformed. Malformed section headers are defined by a line starting with [ but not ending with ].

assert_eq!(
    ini_roundtrip::Parser::new("[Error").nth(1),
    Some(ini_roundtrip::Item::Error("[Error")));

Section

Section header element.

assert_eq!(
    ini_roundtrip::Parser::new("[Section]").nth(1),
    Some(ini_roundtrip::Item::Section{name: "Section", raw: "[Section]"}));

Fields

name: &'a str

Trimmed name of the section

raw: &'a str

Raw line

SectionEnd

End of section.

Pseudo-element emitted before a Section and at the end of the document. This helps processing sections after their properties finished parsing.

assert_eq!(
    ini_roundtrip::Parser::new("").next(),
    Some(ini_roundtrip::Item::SectionEnd));

Property

Property element.

Key value must not contain =.

The value is None if there is no =.

assert_eq!(
    ini_roundtrip::Parser::new("Key=Value").next(),
    Some(ini_roundtrip::Item::Property{key: "Key", val: Some("Value"), raw: "Key=Value"}));
assert_eq!(
    ini_roundtrip::Parser::new("Key").next(),
    Some(ini_roundtrip::Item::Property{key: "Key", val: None, raw: "Key"}));

Fields

key: &'a str

Trimmed key

val: Option<&'a str>

Trimmed value (if any)

raw: &'a str

Raw line

Comment

Comment.

assert_eq!(
    ini_roundtrip::Parser::new(";comment").next(),
    Some(ini_roundtrip::Item::Comment{raw: ";comment"}));

Fields

raw: &'a str

Raw line

Blank

Blank line.

Allows faithful reproduction of the whole ini document including blank lines.

assert_eq!(
    ini_roundtrip::Parser::new("\n").next(),
    Some(ini_roundtrip::Item::Blank{raw: ""}));

Fields

raw: &'a str

Raw line

Trait Implementations

impl<'a> Clone for Item<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Item<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Item<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Item<'a>

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> PartialEq for Item<'a>

fn eq(&self, other: &Item<'a>) -> 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<'a> Copy for Item<'a>

impl<'a> Eq for Item<'a>

impl<'a> StructuralPartialEq for Item<'a>