Skip to main content

DaemonConfig

Struct DaemonConfig 

Source
#[non_exhaustive]
pub struct DaemonConfig { pub daemon: DaemonSection, pub whistle: WhistleSection, pub style: StyleSection, pub interpreters: BTreeMap<String, String>, pub dog: BTreeMap<String, Table>, }
Expand description

Parsed daemon configuration with raw per-dog sections

Dog sections stay untyped here: each dog deserializes its own [dog.<name>] table so dog config schemas live with the dog code.

#[non_exhaustive]: this struct grows a section over time, and each one would otherwise be a breaking change for an out-of-tree struct literal. That is IR-20’s ordinary reasoning applied to a struct. It is not a validation gate, and this type is deliberately not the proof token crate::config::ResolvedApp is: the attribute blocks struct literals and functional-update syntax from outside this crate, but not field mutation, and Self::default followed by an assignment to daemon.max_cron_sleep reaches an unvalidated value without a literal.

The contract is therefore stated, not enforced. Self::load and Self::load_layered are the validating constructors; a caller that mutates a loaded config afterwards is out of contract, and shep-core does not detect it and, with public fields, cannot.

That is the right trade here because nothing ever receives one of these. ResolvedApp protects a property of travel — the supervisor is handed one and must trust normalization it cannot see. Every production site loads a DaemonConfig and consumes it within a few lines (run_daemon renders it straight into BootOptions; shep-daemon’s dogs reads one [dog.<name>] table; shep-cli’s whistle::gate reads one boolean), and the daemon holds a BootOptions, not this. Guarding the one max_cron_sleep floor against a caller who is already out of contract would cost accessors for every field of every section, including a BTreeMap<String, toml::Table> two crates legitimately read. If an out-of-tree caller ever does need to mutate and re-check, the answer is to make validate public — one line, non-breaking — not to privatise the fields. docs/specs/deferred.md records this as resolved.

Nothing in the repository observes the attribute itself: it is invisible inside the defining crate, and seeing it needs a trybuild compile-fail tier this project declined once already for ProcessInfo (see tests/process_info_builder_from_outside_the_crate.rs, which admits the same gap and is required to stay shep-core’s only tests/ file).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§daemon: DaemonSection

The [daemon] section

§whistle: WhistleSection

The [whistle] section

§style: StyleSection

The [style] section

§interpreters: BTreeMap<String, String>

The [interpreters] section: a script extension (no leading dot, "js" not ".js") mapped to the interpreter that runs it.

Read by the CLI only, and applied before a request ever reaches the wire: shep start’s target resolution folds a match into an app’s own AppConfig::interpreter exactly when that field is still unset, the same way --cwd and --fold are folded in there. An app that already names an interpreter – explicitly in a Flockfile, including the literal "none" – is never touched by this map, and --interpreter on the command line outranks both. The daemon itself never reads this field; by the time an app reaches it, the CLI has already resolved the question.

Lives in this daemon-config grammar for the reason StyleSection’s own doc gives for itself: RawDaemonConfig denies unknown top-level keys, so a section this type does not know about is a hard parse error for every shep.toml carrying one – registering it here is what keeps [interpreters] from breaking every daemon boot the moment an operator, or shep’s own first-run scaffold, writes one.

§dog: BTreeMap<String, Table>

Raw [dog.<name>] sections keyed by dog name

Implementations§

Source§

impl DaemonConfig

Source

pub fn load( file_source: Option<&str>, env: &dyn Fn(&str) -> Option<String>, ) -> Result<Self, DaemonConfigError>

Builds config from optional file source + environment overrides

file < env, validated. Equivalent to Self::load_layered with an empty DaemonOverrides; unchanged for every existing caller.

§Errors
Source

pub fn load_layered( file_source: Option<&str>, env: &dyn Fn(&str) -> Option<String>, overrides: &DaemonOverrides, ) -> Result<Self, DaemonConfigError>

Builds config from optional file source + environment + CLI-flag overrides

file < env < flags (spec §5), validated exactly once, at the end — see the private validate method below for why validating per layer instead would be wrong.

§Errors

Trait Implementations§

Source§

impl Clone for DaemonConfig

Source§

fn clone(&self) -> DaemonConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DaemonConfig

Debug implementation does not leak dog config values (IR-41)

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for DaemonConfig

Source§

fn default() -> DaemonConfig

Returns the “default value” for a type. Read more
Source§

impl PartialEq for DaemonConfig

Source§

fn eq(&self, other: &DaemonConfig) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DaemonConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.