Struct SheepConfigView 

#[non_exhaustive]
pub struct SheepConfigView {
    pub name: String,
    pub config: AppConfig,
    pub env_keys: Vec<String>,
    pub overridden: Vec<String>,
    pub pending: Vec<String>,
}

One sheep’s effective config as a pane sees it: every field but env’s values, plus which fields an operator has overridden and which are waiting on a respawn.

The answer to Request::SheepConfig, and the one reply in this module that carries a whole AppConfig. SheepApplied deliberately carries field names alone, and the difference is what each is for: that one is printed at an operator who already has the file, this one feeds a pane that is about to edit fields it has to be able to show first.

Fields (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.

config: AppConfig

The effective config with env cleared. Every remaining field is operator-supplied policy the pane is about to let them edit, so withholding a value would make the pane unusable while protecting nothing.

env_keys: Vec<String>

The env keys, so the pane can list them. Never the values.

overridden: Vec<String>

Field names an operator has set that the Flockfile does not declare.

pending: Vec<String>

Field names parked until the next respawn.

Implementations

impl SheepConfigView

pub fn new( config: AppConfig, overridden: Vec<String>, pending: Vec<String>, ) -> Self

Builds one, clearing env and recording its keys.

The clearing happens here rather than at the one call site, so a second caller cannot forget it: this constructor is the only way to build the type outside this crate, since #[non_exhaustive] blocks a literal.

Trait Implementations

impl Clone for SheepConfigView

fn clone(&self) -> SheepConfigView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SheepConfigView

Redacted (IR-41): config carries args and cwd, which routinely hold a token or a home directory, and this type is what a {:?} on a Response would print. The three lists are counted rather than named for the same reason: env_keys is a key set, which is itself worth keeping out of a log.

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SheepConfigView

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SheepConfigView

impl PartialEq for SheepConfigView

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SheepConfigView

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SheepConfigView