Struct Diagnostic 

pub struct Diagnostic {
    pub schema: &'static str,
    pub reason: Reason,
    pub message: String,
    pub expected: Option<String>,
    pub action: Option<String>,
    pub retry: Option<bool>,
    pub target_state: Option<String>,
    pub step: Option<String>,
    pub run: Option<String>,
}

One failure, with its parts named.

A hint that is not known is omitted rather than invented, so every optional field serializes only when present.

Fields

schema: &'static str

The shape version of the JSON rendering.

reason: Reason

One entry from the closed vocabulary.

message: String

What happened, one line.

expected: Option<String>

What would have had to be true.

action: Option<String>

The exact command or change that fixes it, when known.

retry: Option<bool>

Whether rerunning as-is can succeed.

target_state: Option<String>

What the run left behind, stated plainly.

step: Option<String>

The step it happened in, where there is one.

run: Option<String>

The run journal explaining it, where one was written.

Implementations

impl Diagnostic

pub fn new(reason: Reason, message: impl Into<String>) -> Self

A diagnostic carrying only its reason and message; the builder methods add what is actually known.

pub fn expected(self, expected: impl Into<String>) -> Self

State what would have had to be true.

pub fn action(self, action: impl Into<String>) -> Self

Name the command or change that fixes it.

pub fn target_state(self, state: impl Into<String>) -> Self

State what the run left behind.

pub fn step(self, step: impl Into<String>) -> Self

Name the step the failure happened in.

pub fn run(self, run: impl Into<String>) -> Self

Name the run journal that explains the failure.

pub fn render_human(&self) -> String

The human rendering: the five questions in order — what happened, what was expected, what to do, how to resume, what state the target is in — with unknown lines absent rather than invented.

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Diagnostic

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

Formats the value using the given formatter.

impl Serialize for Diagnostic

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

where __S: Serializer,

Serialize this value into the given Serde serializer.