Enum ObligationState 

pub enum ObligationState {
    Owed,
    Discharged,
    Stale,
    Undeclared,
}

Where one obligation stands.

The words are the validator’s verdicts, not a severity scale: stale is not a worse owed, it is evidence that was true and no longer describes what it proved.

use majordomus_cli::capability::builtin::obligations::ObligationState;
// only one of the four lets a task be called completed
let completable = |s: ObligationState| s == ObligationState::Discharged;
assert!(completable(ObligationState::Discharged));
assert!(!completable(ObligationState::Stale), "evidence that no longer describes the tree");
assert!(!completable(ObligationState::Owed));
assert!(!completable(ObligationState::Undeclared));

Variants

Owed

Declared, and no evidence for it was ever recorded.

Discharged

Evidence exists and still describes this tree, or this commit.

Stale

Evidence exists and no longer describes what it proved: the inputs changed, or the commit it named is not this one.

Undeclared

The task requires a token the shipped vocabulary does not declare. Nothing can discharge it, because nothing knows what would.

Implementations

impl ObligationState

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

The word as serialised, for a caller that tallies or renders states without carrying a copy of the vocabulary: the tallies of a Closure are keyed by exactly these strings, and so is anything that groups the entries by standing.

use majordomus_cli::capability::builtin::obligations::ObligationState;
assert_eq!(ObligationState::Stale.as_str(), "stale");
assert_eq!(ObligationState::Undeclared.as_str(), "undeclared");

Trait Implementations

impl Clone for ObligationState

fn clone(&self) -> ObligationState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ObligationState

impl Debug for ObligationState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ObligationState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ObligationState

impl JsonSchema for ObligationState

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for ObligationState

fn cmp(&self, other: &ObligationState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ObligationState

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ObligationState

fn partial_cmp(&self, other: &ObligationState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ObligationState

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 ObligationState