Enum Outcome 

#[non_exhaustive]
pub enum Outcome {
    Completed,
    Waiting,
    Skipped,
    Failed,
    Abandoned,
}

What a reconciliation pass, or a step of one, concluded.

as_str gives the value used as a metric label, which is stable.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Completed

Brought what it manages to the desired state, or found it already there.

Waiting

Made progress, but the desired state has not been reached yet, and asked to be run again to continue.

Skipped

Had nothing to do, for instance because what it manages is disabled by configuration. Never inferred; reconcilers must report it explicitly.

Failed

Returned an error.

Abandoned

Stopped without reaching a conclusion: either the reconciliation was cancelled (for instance because leadership was lost, or the process is shutting down), or, for a Step, an error propagated out of it before it was finished.

Implementations

impl Outcome

pub fn as_str(self) -> &'static str

The label value for this outcome.

pub fn of_result<E>(result: &Result<Option<Action>, E>) -> Self

Classifies a result in the form returned by Context::apply and Context::cleanup:

• Ok(None) and Ok(Some(Action::await_change())) are Completed, since there is nothing more to do until something changes.
• Any other Ok(Some(action)) is Waiting, since the reconciler asked to be run again.
• Err(_) is Failed.

A reconciler that returns a requeue action as a periodic resync after having fully converged will therefore be reported as waiting, and should override that with TraceMetadata::set_outcome.

Trait Implementations

impl Clone for Outcome

fn clone(&self) -> Outcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Outcome

impl Debug for Outcome

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

Formats the value using the given formatter.

impl Display for Outcome

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

Formats the value using the given formatter.

impl Eq for Outcome

impl Hash for Outcome

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Outcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Outcome