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
23// Shared atomic-write primitive: barks, kv, overrides, shep.toml, dogs.toml
24// and the muster roll all write through it.
25pub mod atomic_file;
26pub mod barks;
27pub mod config;
28// The probe contract both sides of a dog's `--version`/`--schema` answer
29// parse: flag names, the answer grammar, the schema's secret marker key.
30pub mod dogs;
31pub mod kv;
32// One definition of the log-line timestamp for the writer and every reader:
33// the daemon stamps, and three different file readers in shep-cli strip.
34pub mod logstamp;
35pub mod overrides;
36pub mod paths;
37pub mod protocol;
38pub mod selector;
39pub mod signals;
40pub mod status;
41// OS-specific transport (unix socket or named pipe) lives here so nothing
42// above it needs a `cfg`.
43pub mod transport;
44pub mod values;
45
46/// One-import surface for downstream crates
47pub mod prelude {
48 #[doc(no_inline)]
49 pub use crate::config::{AppConfig, DeclaredApp, Flockfile};
50 #[doc(no_inline)]
51 pub use crate::paths::ShepPaths;
52 #[doc(no_inline)]
53 pub use crate::selector::ProcessSelector;
54 #[doc(no_inline)]
55 pub use crate::status::ProcStatus;
56 #[doc(no_inline)]
57 pub use crate::values::{MemSize, UpDuration};
58}