Skip to main content

hydro_lang/compile/
mod.rs

1//! Hydro compilation: the Hydro IR, Hydro to DFIR translation, and traits for deployment targets.
2
3#[expect(missing_docs, reason = "TODO")]
4pub mod ir;
5
6#[cfg(feature = "build")]
7#[cfg_attr(docsrs, doc(cfg(feature = "build")))]
8#[expect(missing_docs, reason = "TODO")]
9pub mod built;
10
11#[cfg(feature = "build")]
12#[cfg_attr(docsrs, doc(cfg(feature = "build")))]
13#[expect(missing_docs, reason = "TODO")]
14pub mod compiled;
15
16#[cfg(feature = "build")]
17#[cfg_attr(docsrs, doc(cfg(feature = "build")))]
18#[expect(missing_docs, reason = "TODO")]
19pub mod deploy;
20
21#[cfg(feature = "build")]
22#[cfg_attr(docsrs, doc(cfg(feature = "build")))]
23pub mod embedded;
24
25pub mod embedded_runtime;
26
27#[cfg(feature = "build")]
28#[cfg_attr(docsrs, doc(cfg(feature = "build")))]
29#[expect(missing_docs, reason = "TODO")]
30pub mod deploy_provider;
31
32#[expect(missing_docs, reason = "TODO")]
33pub mod builder;
34
35/// Forward consistency analysis for Hydro IR sinks.
36pub mod consistency_label;
37
38#[cfg(stageleft_runtime)]
39#[cfg(feature = "trybuild")]
40#[cfg_attr(docsrs, doc(cfg(feature = "trybuild")))]
41#[expect(missing_docs, reason = "TODO")]
42#[cfg_attr(
43    not(any(feature = "deploy", feature = "sim", feature = "maelstrom")),
44    expect(
45        dead_code,
46        reason = "\"trybuild\" feature should be enabled by \"deploy\" / \"sim\" / \"maelstrom\""
47    )
48)]
49pub mod trybuild;
50
51#[cfg(stageleft_runtime)]
52#[cfg(feature = "trybuild")]
53#[cfg_attr(docsrs, doc(cfg(feature = "trybuild")))]
54pub use trybuild::generate::init_test;
55
56/// Ident used for the DFIR runtime instance variable name.
57#[cfg(feature = "build")]
58#[cfg_attr(docsrs, doc(cfg(feature = "build")))]
59pub(crate) const DFIR_IDENT: &str = "flow";