fef 0.2.3

Rust implementation of a parser of the FEF format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

//! Parsing of a [FEF](https://github.com/jiricekcz/fef-specification/blob/main/README.md#format) byte stream
//!
//! FEF as a format is intended to be embedded in other formats (most often that will be the [expression](https://github.com/jiricekcz/fef-specification/blob/main/expressions/Expression.md) part).
//! For that reason this library exposes function for parsing top level FEF structures and gives emphasis on those.
//! Function for reading files are also provided, but they are, for now, meant to serve the most common use cases only
//! and do not provide the same level of control as the functions for parsing top level structures.
//!
//! # Common Interface
//!
//! All parsing is done on a byte stream (`&mut R` where `R: std::io::Read`). When it makes sense, the parsing is also done
//! sequentially, so that the whole byte stream does not need to be loaded into memory at once.
mod configuration;
mod expression;
mod file;
mod metadata;

pub use expression::read_expression;
pub use expression::read_expression_into_tree;

pub use configuration::read_configuration;
pub use configuration::read_configuration_with_default_configuration;

pub use metadata::read_metadata;
pub use metadata::read_metadata_as_vec;

pub use file::read_file;
pub use file::read_file_with_default_config;