flowrclib/lib.rs
1#![deny(missing_docs)]
2#![warn(clippy::unwrap_used)]
3
4//! This is the rust `flow` Compiler Library. It can be linked with other code to produce
5//! a flow compiler, such as the `flowc` command line flow compiler.
6
7/// reads [flow definitions][flowcore::model::flow_definition] into memory, flattens and connects
8/// that into a graph of [runtime functions][flowcore::model::runtime_function::RuntimeFunction]
9pub mod compiler;
10
11/// used to output a human readable version of the model and compiler tables to help debug
12/// compiler problems
13pub mod dumper;
14
15/// takes care of generating the [flow's manifest][flowcore::model::flow_manifest::FlowManifest]
16/// (for later execution by a flow runner) from the [compiler tables][compiler::compile::CompilerTables]
17pub mod generator;
18
19/// provides methods to get information about this version of the flowrclib library
20pub mod info;
21
22/// contains [errors::Error] that other modules in this crate will `use errors::*;`
23/// to get access to everything `error_chain` creates.
24pub mod errors;