Struct sise::TreeReader

pub struct TreeReader<'a> { /* fields omitted */ }

Reader that allows reading from a tree of Node.

Example

use sise::sise_expr;
use sise::Reader as _;
let root_node = sise_expr!(["test", ["1", "2", "3"]]);
let mut reader = sise::TreeReader::new(&root_node);
assert_eq!(reader.read().unwrap().kind, sise::ReadItemKind::ListBeginning);
assert_eq!(reader.read().unwrap().kind, sise::ReadItemKind::Atom("test"));
assert_eq!(reader.read().unwrap().kind, sise::ReadItemKind::ListBeginning);
assert_eq!(reader.read().unwrap().kind, sise::ReadItemKind::Atom("1"));
assert_eq!(reader.read().unwrap().kind, sise::ReadItemKind::Atom("2"));
assert_eq!(reader.read().unwrap().kind, sise::ReadItemKind::Atom("3"));
assert_eq!(reader.read().unwrap().kind, sise::ReadItemKind::ListEnding);
assert_eq!(reader.read().unwrap().kind, sise::ReadItemKind::ListEnding);
reader.finish().unwrap();

Methods

impl<'a> TreeReader<'a>

pub fn new(root_node: &'a Node) -> Self

Trait Implementations

impl<'a> Reader for TreeReader<'a>

type Error = Infallible

The error type that may be produced while reading.

type String = &'a str

A type that can be either a borrowed as a str or converted into an owned String.

type Pos = ()

A type that represent the position of a node.

fn read(&mut self) -> Result<ReadItem<&'a str, ()>, Infallible>

Reads from the source. It shall panic if the root node has been completely read (e.g., the ListEnding that matches the first ListBeginning has been read).

fn finish(self) -> Result<(), Infallible>

Finished the reader, consuming it. It must be called only after the root node has been completely read. It may return an error if an error is encountered after the root node (e.g., trailing tokens at the end of the file).