Skip to main content

Crate shep_core

Crate shep_core 

Source
Expand description

Shared foundation of the shep workspace

Typed configuration (Flockfile + daemon config), value newtypes, process selectors, $SHEP_HOME paths, and wire protocol version 1. Every other crate depends on this one; it depends on no sibling.

§Quick start

use shep_core::prelude::*;

let app: AppConfig = toml::from_str("name = \"web\"\nscript = \"./srv\"").unwrap();
assert!(app.autorestart);
let limit: MemSize = "512M".parse().unwrap();
assert_eq!(limit.bytes(), 512 << 20);

Module-by-module design: docs/systematic-refactor/refactor-workspace/map.md; behavior contract: docs/specs/shep-v1.md.

Modules§

atomic_file
The atomic file replace, its first step and its last
barks
barks.jsonl: the size-capped ring of fired alerts (spec §10.4).
config
Configuration: per-app schema (Flockfile), normalization, discovery, and the daemon’s own shep.toml
kv
kv.json: the shepherd’s key/value store (spec §5).
logstamp
The timestamp every line in a sheep’s or a dog’s log file carries, and how a reader takes it back off.
overrides
overrides.json: what an operator has changed since a Flockfile was loaded.
paths
On-disk layout of $SHEP_HOME
prelude
One-import surface for downstream crates
protocol
The client<->daemon wire protocol (version 2)
selector
Target selection: one parse for every CLI verb and RPC filter
signals
The signals shep signal may name.
status
Process lifecycle status
transport
The control transport: one address, two implementations
values
Config value newtypes: memory sizes and durations