Crate oak_runtime [] [src]

This is the documentation of the Oak runtime. Oak is a parser generator of Parsing Expression Grammar, please read first the manual.

This library is used by the generated code of Oak and is also necessary to any Oak users for interfacing with the code generated. A PEG combinator returns a ParseState, please consult the methods into_result or unwrap_data as they are good starting point for retrieving useful information.

Reexports

pub use str_stream::*;
pub use stream::*;
pub use parse_state::*;

Modules

file_map_stream
parse_state

A parsing state indicates the current status of the parsing. It is mainly used by compiled PEG combinators.

str_stream

Implementation of Stream for &'a str type. It implements all traits required by CharStream.

stream

Collection of traits for retrieving and manipulating a stream. They are used by implementation of parsing expressions.

Functions

make_span