dfir_rs 0.17.0-alpha.1

DFIR runtime for Rust, used by Hydro.
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

#![cfg_attr(docsrs, feature(doc_cfg))]
#![warn(missing_docs)]

//! DFIR is a low-level dataflow-based runtime system for the [Hydro Project](https://hydro.run/).
//!
//! The primary item in this crate is the [`Dfir`](crate::scheduled::context::Dfir) struct,
//! representing a DFIR dataflow instance. Instantiate one with the
//! [`dfir_syntax!`] macro using DFIR's custom syntax.
//!
//! ```rust
//! let mut df = dfir_rs::dfir_syntax! {
//!     source_iter(["hello", "world"]) -> for_each(|s| println!("{}", s));
//! };
//! df.run_available();
//! ```
//!
//! For more examples, check out the [`examples` folder on Github](https://github.com/hydro-project/hydro/tree/main/dfir_rs/examples).

pub mod compiled;
pub mod scheduled;
pub mod util;

#[doc(hidden)]
pub use ::{
    bincode, bumpalo, bytes, dfir_lang, dfir_lang as lang, dfir_pipes, futures, lattices,
    pin_project_lite, rustc_hash, serde, serde_json, sinktools, slotmap, tokio, tokio_stream,
    tokio_util, tracing, variadics, web_time,
};
#[doc(hidden)]
pub use dfir_pipes::itertools;
#[doc(hidden)]
pub use variadics::{var_args, var_expr, var_type};

/// `#[macro_use]` automagically brings the declarative macro export to the crate-level.
mod declarative_macro;
#[cfg_attr(docsrs, doc(cfg(feature = "dfir_macro")))]
#[cfg(feature = "dfir_macro")]
pub use dfir_macro::{
    DemuxEnum, dfir_main as main, dfir_parser, dfir_syntax, dfir_syntax_noemit, dfir_test as test,
    monotonic_fn, morphism,
};
pub use futures::never::Never;

#[cfg(doctest)]
mod booktest {
    mod surface_ops {
        include_mdtests::include_mdtests!("docs/docgen/*.md");
    }
}