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 lock a config file's writers hold across their read-modify-write, and
29// the staging file they write through. Lives here rather than in shep-cli
30// (where it was born) so shep-daemon can hold it too, once it starts writing
31// `dogs.toml`.
32pub mod config_lock;
33// The probe contract both sides of a dog's `--version`/`--schema` answer
34// parse: flag names, the answer grammar, the schema's secret marker key.
35pub mod dogs;
36pub mod kv;
37// One definition of the log-line timestamp for the writer and every reader:
38// the daemon stamps, and three different file readers in shep-cli strip.
39pub mod logstamp;
40pub mod overrides;
41pub mod paths;
42pub mod protocol;
43pub mod selector;
44pub mod signals;
45pub mod status;
46// OS-specific transport (unix socket or named pipe) lives here so nothing
47// above it needs a `cfg`.
48pub mod transport;
49pub mod values;
50
51/// One-import surface for downstream crates
52pub mod prelude {
53    #[doc(no_inline)]
54    pub use crate::config::{AppConfig, DeclaredApp, Flockfile};
55    #[doc(no_inline)]
56    pub use crate::paths::ShepPaths;
57    #[doc(no_inline)]
58    pub use crate::selector::ProcessSelector;
59    #[doc(no_inline)]
60    pub use crate::status::ProcStatus;
61    #[doc(no_inline)]
62    pub use crate::values::{MemSize, UpDuration};
63}
shep_core/lib.rs

shep_core/
lib.rs
