shep_core/lib.rs
1//! Shared foundation of the shep workspace
2//!
3//! Typed configuration (Flockfile + daemon config), value newtypes,
4//! process selectors, `$SHEP_HOME` paths, and wire protocol version 1.
5//! Every other crate depends on this one; it depends on no sibling.
6//!
7//! # Quick start
8//! ```
9//! use shep_core::prelude::*;
10//!
11//! let app: AppConfig = toml::from_str("name = \"web\"\nscript = \"./srv\"").unwrap();
12//! assert!(app.autorestart);
13//! let limit: MemSize = "512M".parse().unwrap();
14//! assert_eq!(limit.bytes(), 512 << 20);
15//! ```
16//!
17//! Module-by-module design: `docs/systematic-refactor/refactor-workspace/map.md`;
18//! behavior contract: `docs/specs/shep-v1.md`.
19
20#![doc(test(attr(deny(warnings))))]
21#![forbid(unsafe_code)]
22
23pub mod barks;
24pub mod config;
25pub mod kv;
26pub mod paths;
27pub mod protocol;
28pub mod selector;
29pub mod signals;
30pub mod status;
31// Declared next to `protocol`, deliberately: that module owns what travels
32// over the control plane and this one owns what carries it. Keeping the two
33// in one crate is what lets every layer above them — the client's actor, the
34// daemon's connection state machine, every RPC verb — be written once with
35// no `cfg` in it at all.
36pub mod transport;
37pub mod values;
38
39/// One-import surface for downstream crates
40pub mod prelude {
41 #[doc(no_inline)]
42 pub use crate::config::{AppConfig, Flockfile};
43 #[doc(no_inline)]
44 pub use crate::paths::ShepPaths;
45 #[doc(no_inline)]
46 pub use crate::selector::ProcessSelector;
47 #[doc(no_inline)]
48 pub use crate::status::ProcStatus;
49 #[doc(no_inline)]
50 pub use crate::values::{MemSize, UpDuration};
51}