Skip to main content

SheepApplied

Struct SheepApplied 

Source
#[non_exhaustive]
pub struct SheepApplied { pub name: String, pub applied: Vec<String>, pub pending: Vec<String>, pub refused: Option<String>, }
Expand description

What one app’s Request::ApplyConfig did: the answer a load owes the operator who ran it

One of these per app the request named, whether or not the app was found and whether or not anything about it changed. A load that quietly skipped an app would leave an operator reading a Flockfile that says one thing and a flock doing another, which is the failure this whole verb exists to fix.

Self::applied and Self::pending carry field NAMES only, never their values, exactly as SheepDrift carries them and for the same reason: this is built to be printed at an operator, and AppConfig::env carries secrets, so an applied env reports "env" and nothing more (IR-41). The merged config itself never reaches a client at all – the daemon keeps it, because a config is not something a client needs and env is in it.

Self::refused is prose and is deliberately not held to that, so the rule above is scoped to the two lists rather than stated of the whole type. A refusal is a sentence an operator reads, and the useful ones name the thing that was refused: the daemon’s own instance-count refusal quotes the count the file asked for, and a rejected {{...}} template quotes the offending fragment. Those are values out of the FILE the caller just sent, not values out of the flock’s stored config, which is what makes them safe to echo; see that field’s own doc. A refusal that needs to name an env value is one the daemon must word differently, not one this type can prevent.

Debug is derived on that basis: refused holds only what the daemon chose to put in front of an operator anyway, so there is nothing here to redact that redacting would help.

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.
§name: String

The sheep’s name, exactly as the request spelled it.

§applied: Vec<String>

Fields now in force, in field-name order. Empty when the load changed nothing the daemon could act on immediately.

§pending: Vec<String>

Fields the app picks up at its next spawn, in field-name order. Empty when nothing is waiting.

shep reload <name> is what promotes them; a client rendering this list says so, because a pending list with no remedy beside it is a report nobody can act on.

§refused: Option<String>

Why some or all of this app’s change did not land, in the daemon’s own words, or None when the whole of it did.

Not the same question as the two lists being empty. A refusal raised before anything was touched leaves both empty, and so does a load with nothing to do; a refusal raised after the flock was already reshaped arrives beside lists that carry what did land. The message is what tells them apart, which is why it is a sentence rather than a code.

Implementations§

Source§

impl SheepApplied

Source

pub fn new( name: impl Into<String>, applied: Vec<String>, pending: Vec<String>, refused: Option<String>, ) -> Self

Builds one app’s report.

No builder, matching SheepDrift::new: all four fields are required and none can be defaulted to something honest, so there is no optional surface for one to spare a caller.

Trait Implementations§

Source§

impl Clone for SheepApplied

Source§

fn clone(&self) -> SheepApplied

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 SheepApplied

Source§

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

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

impl<'de> Deserialize<'de> for SheepApplied

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 SheepApplied

Source§

impl PartialEq for SheepApplied

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for SheepApplied

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SheepApplied

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, !>

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.