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::context::Dfir) struct,
7//! representing a DFIR dataflow instance. Instantiate one with the
8//! [`dfir_syntax!`] macro using DFIR's custom syntax.
9//!
10//! ```rust
11//! let mut df = dfir_rs::dfir_syntax! {
12//!     source_iter(["hello", "world"]) -> for_each(|s| println!("{}", s));
13//! };
14//! df.run_available();
15//! ```
16//!
17//! For more examples, check out the [`examples` folder on Github](https://github.com/hydro-project/hydro/tree/main/dfir_rs/examples).
18
19pub mod compiled;
20pub mod scheduled;
21pub mod util;
22
23#[doc(hidden)]
24pub use ::{
25    bincode, bumpalo, bytes, dfir_lang, dfir_lang as lang, dfir_pipes, futures, lattices,
26    pin_project_lite, rustc_hash, serde, serde_json, sinktools, slotmap, tracing, variadics,
27    web_time,
28};
29#[cfg(feature = "tokio")]
30pub use ::{tokio, tokio_stream, tokio_util};
31#[doc(hidden)]
32pub use dfir_pipes::itertools;
33#[doc(hidden)]
34pub use variadics::{var_args, var_expr, var_type};
35
36/// `#[macro_use]` automagically brings the declarative macro export to the crate-level.
37mod declarative_macro;
38#[cfg_attr(docsrs, doc(cfg(feature = "dfir_macro")))]
39#[cfg(feature = "dfir_macro")]
40pub use dfir_macro::{
41    DemuxEnum, dfir_main as main, dfir_parser, dfir_syntax, dfir_syntax_noemit, dfir_test as test,
42    monotonic_fn, morphism,
43};
44pub use futures::never::Never;
45
46#[cfg(doctest)]
47mod booktest {
48    mod surface_ops {
49        include_mdtests::include_mdtests!("docs/docgen/*.md");
50    }
51}
dfir_rs/lib.rs

dfir_rs/
lib.rs
