Struct Parser 

pub struct Parser<'a> { /* private fields */ }

Parser.

Iteration

Box<Parser> implements IntoIterator<Item = Result<Event, ParserError>>, and thus can be used in for loops. The iterator is fused, and produces None forever after the end of stream or after a first encountered error.

Implementations

impl<'a> Parser<'a>

pub fn new<R: Read + 'a>(reader: R) -> Result<Box<Self>, ParserError>

Create a parser with default configuration.

If a custom configuration is needed, use ParserBuilder to build a Parser instance.

Examples found in repository

examples/canonicalize.rs (line 7)

fn main() -> Result<(), Box<dyn error::Error>> {
    // Parser with default configuration.
    let parser = libyaml::Parser::new(io::stdin())?;

    // Emitter with custom configuration: enable canonical output.
    let mut emitter = libyaml::EmitterBuilder::new(io::stdout())?
        .canonical(true)
        .finish();

    // Parser implements IntoIterator and thus can be used in a for loop.
    for event in parser {
        emitter.emit(event?)?;
    }

    Ok(())
}

pub fn parse(&mut self) -> Result<Event, ParserError>

Parse an event.

pub fn as_raw_ptr(&mut self) -> *mut yaml_parser_t

Return raw pointer to the underlying yaml_parser_t.

Trait Implementations

impl Drop for Parser<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> IntoIterator for Box<Parser<'a>>

type Item = <ParserIter<'a> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = ParserIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.