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;
26// One definition of the log-line timestamp for the writer and every reader:
27// the daemon stamps, and three different file readers in shep-cli strip.
28pub mod logstamp;
29pub mod paths;
30pub mod protocol;
31pub mod selector;
32pub mod signals;
33pub mod status;
34// Declared next to `protocol`, deliberately: that module owns what travels
35// over the control plane and this one owns what carries it. Keeping the two
36// in one crate is what lets every layer above them — the client's actor, the
37// daemon's connection state machine, every RPC verb — be written once with
38// no `cfg` in it at all.
39pub mod transport;
40pub mod values;
41
42/// One-import surface for downstream crates
43pub mod prelude {
44 #[doc(no_inline)]
45 pub use crate::config::{AppConfig, Flockfile};
46 #[doc(no_inline)]
47 pub use crate::paths::ShepPaths;
48 #[doc(no_inline)]
49 pub use crate::selector::ProcessSelector;
50 #[doc(no_inline)]
51 pub use crate::status::ProcStatus;
52 #[doc(no_inline)]
53 pub use crate::values::{MemSize, UpDuration};
54}