Struct Outcome 

pub struct Outcome<T> {
    pub value: T,
    pub diagnostics: Vec<Diagnostic>,
}

A command result paired with any non-fatal diagnostics produced along the way.

cooklang parses leniently: a recipe can parse successfully and still carry warnings. Consumers that do not care about diagnostics ignore the field.

When a command returns Err and when it returns error diagnostics

An Outcome on the success path may still carry Severity::Error diagnostics. The rule commands follow is:

• Return Err(CoreError) when the command could not produce its value. recipe::read cannot return a recipe that failed to parse, so it returns Err.
• Return Ok(Outcome) with error-severity diagnostics when producing the value is the job and the errors are the payload. doctor::validate reports broken recipes as data and must still succeed.

Callers that treat any error diagnostic as failure — a CI exit code, say — check has_errors in addition to the Result.

Fields

value: T

What the command produced.

diagnostics: Vec<Diagnostic>

Problems found while producing it. May be empty.

Implementations

impl<T> Outcome<T>

pub fn new(value: T) -> Self

Wrap a value with no diagnostics.

pub fn with_diagnostics(value: T, diagnostics: Vec<Diagnostic>) -> Self

Wrap a value together with diagnostics.

pub fn into_value(self) -> T

Discard diagnostics and take the value.

pub fn has_errors(&self) -> bool

True when any diagnostic has Severity::Error.

Trait Implementations

impl<T: Clone> Clone for Outcome<T>

fn clone(&self) -> Outcome<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Outcome<T>

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

Formats the value using the given formatter.