Skip to main content

substrate_kit/
lib.rs

1//! # Substrate Kit
2//!
3//! The board-agnostic Linux+dockerd substrate that services run on: container lifecycle, cgroups, mounts, and the
4//! service-principal embodiment layer.
5//!
6//! Linux is the supported platform. The crate compiles elsewhere, but cgroup and mount-namespace resolution read
7//! the Linux `/proc` filesystem. See the README for scope and status.
8
9pub mod cgroup;
10pub mod error;
11pub mod lifecycle;
12pub mod mount;
13pub mod principal;
14pub mod socket;
15
16pub use error::SubstrateError;
17pub use principal::{embody, ContainerRef, Embodiment};
18
19/// Crate version, sourced from `Cargo.toml`.
20pub const VERSION: &str = env!("CARGO_PKG_VERSION");
21
22#[cfg(test)]
23mod tests {
24    use super::*;
25
26    #[test]
27    fn version_is_set() {
28        assert!(!VERSION.is_empty());
29    }
30}