Struct ConfigCheck 

pub struct ConfigCheck {
    pub valid: bool,
    pub message: String,
    pub warnings: Vec<String>,
    pub admission: AdmissionPolicy,
    pub memory_caps: Option<u64>,
    pub memory_needed: Option<u64>,
    pub memory_max: Option<u64>,
    pub revision: Option<String>,
}

POST /v1/config/check and PUT /v1/config: what runnerd check-config prints for a config. PUT refuses an invalid one with 422 and this body, which has an ErrorResponse’s message.

Fields

valid: bool

Whether the daemon can run it.

message: String

valid, memory caps sum to …, or why it is not valid.

warnings: Vec<String>

What a valid config should still fix.

admission: AdmissionPolicy

[host] admission, which decides what must fit MemoryMax: memory_caps under caps, memory_needed under measured. Caps from a daemon before it said.

memory_caps: Option<u64>

Bytes every slot and the mirror take at their caps, all at once, when it parses.

memory_needed: Option<u64>

Bytes the admission rule must fit in MemoryMax, when it parses: memory_caps under caps; under measured, the largest single runner with the mirror. None from a daemon before it said.

memory_max: Option<u64>

The MemoryMax of the slice it names; None when unlimited or unknown.

revision: Option<String>

From PUT /v1/config, once written: the revision of the text written, to make the next change against. None from a check, or from a daemon before it.

Implementations

impl ConfigCheck

pub fn verdict(&self, parsed: Option<&Config>) -> Verdict

Its verdict: whether it is valid, and whether its budget fits. With parsed, the config it checked, only a budget past MemoryMax that is the reason it is not valid does not fit; without it, as when the text does not parse, a budget the check reports past MemoryMax.

pub fn budget(&self, parsed: Option<&Config>) -> Option<CheckBudget>

What its admission rule holds to MemoryMax, when known: from the check, or from a daemon before it said, from parsed, the config it checked. None when neither knows, as when the caps overflow.

pub fn doctor_check(&self) -> Check

Doctor’s check of the config the daemon runs with: it passes with its message, or with its warnings, or fails with why.

Trait Implementations

impl Clone for ConfigCheck

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigCheck

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigCheck

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ConfigCheck

impl PartialEq for ConfigCheck

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ConfigCheck

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 ConfigCheck