dfir_rs/
lib.rs

1#![cfg_attr(docsrs, feature(doc_cfg))]
2#![warn(missing_docs)]
3
4//! DFIR is a low-level dataflow-based runtime system for the [Hydro Project](https://hydro.run/).
5//!
6//! The primary item in this crate is the [`Dfir`](crate::scheduled::graph::Dfir) struct,
7//! representing a DFIR dataflow graph. Although this graph can be manually constructed, the
8//! easiest way to instantiate a graph instance is with the [`dfir_syntax!`] macro using
9//! DFIR's custom syntax.
10//!
11//! ```rust
12//! let mut df = dfir_rs::dfir_syntax! {
13//!     source_iter(["hello", "world"]) -> for_each(|s| println!("{}", s));
14//! };
15//! df.run_available();
16//! ```
17//!
18//! For more examples, check out the [`examples` folder on Github](https://github.com/hydro-project/hydro/tree/main/dfir_rs/examples).
19
20pub mod compiled;
21pub mod scheduled;
22pub mod util;
23
24pub use ::{
25    bincode, bytes, dfir_pipes, futures, lattices, pin_project_lite, rustc_hash, serde, serde_json,
26    sinktools, tokio, tokio_stream, tokio_util, tracing, web_time,
27};
28#[cfg(feature = "meta")]
29#[cfg_attr(docsrs, doc(cfg(feature = "meta")))]
30pub use dfir_lang as lang;
31pub use dfir_pipes::itertools;
32pub use variadics::{self, var_args, var_expr, var_type};
33
34/// `#[macro_use]` automagically brings the declarative macro export to the crate-level.
35mod declarative_macro;
36#[cfg_attr(docsrs, doc(cfg(feature = "dfir_macro")))]
37#[cfg(feature = "dfir_macro")]
38pub use dfir_macro::{
39    DemuxEnum, dfir_main as main, dfir_parser, dfir_syntax, dfir_syntax_noemit, dfir_test as test,
40    monotonic_fn, morphism,
41};
42pub use futures::never::Never;
43
44#[cfg(doctest)]
45mod booktest {
46    mod surface_ops {
47        include_mdtests::include_mdtests!("docs/docgen/*.md");
48    }
49}
dfir_rs/lib.rs

dfir_rs/
lib.rs
