Skip to main content

WhistleSection

Struct WhistleSection 

Source
pub struct WhistleSection {
    pub allow_control: bool,
}
Expand description

The [whistle] section

One key, and it is a gate rather than a tuning knob: shep whistle’s four control tools (start_sheep, stop_sheep, restart_sheep, reload_sheep) exist only when this is true, and its five read-only tools exist regardless.

This lives in the shepherd’s config file and nowhere else. There is no --allow-control flag and no SHEP_* variable, deliberately: spec §14.7 rules that whistle’s gate is daemon config because config is auditable and flags are per-invocation. That is a legibility argument, not a containment one — --home/SHEP_HOME already choose which shep.toml gets read, so a flag would open nothing those don’t already; a boolean in a file just leaves a diff and an mtime an operator can audit.

The shepherd itself never reads this key — shep whistle reads the file directly, at startup, in its own process. It is here because this struct is the grammar of shep.toml: RawDaemonConfig denies unknown fields, so a [whistle] section the grammar does not know about would refuse the whole file to boot rather than being silently ignored.

Debug is derived rather than redacted (IR-41): one boolean, no secret, nothing a {:?} could leak.

Fields§

§allow_control: bool

Whether shep whistle offers its control tools. Default false.

Trait Implementations§

Source§

impl Clone for WhistleSection

Source§

fn clone(&self) -> WhistleSection

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 Copy for WhistleSection

Source§

impl Debug for WhistleSection

Source§

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

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

impl Default for WhistleSection

Source§

fn default() -> WhistleSection

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

impl<'de> Deserialize<'de> for WhistleSection

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for WhistleSection

Source§

impl PartialEq for WhistleSection

Source§

fn eq(&self, other: &WhistleSection) -> 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 WhistleSection

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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, <T as TryFrom<U>>::Error>

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.