Enum FieldProvenance 

pub enum FieldProvenance {
    Explicit,
    Derived,
    Inferred,
    Unknown,
}

Where a value came from, and therefore how much weight a reader may put on it.

The four words are not degrees of confidence, they are four different relations to the repository, and the distinction that matters most is the first from the last two: a person wrote it, or a machine worked it out.

use majordomus_cli::devtask::{AttestedText, FieldProvenance};

// a value the record itself carried
let title = AttestedText::explicit("Ship it", ".ai/repo/project/issues/I0001.yaml#title");
assert_eq!(title.provenance, FieldProvenance::Explicit);

// a key the record does not have is unknown, and unknown carries no value
let missing = AttestedText::unknown(
    ".ai/repo/project/issues/I0001.yaml#objective",
    "the record declares no `objective`",
);
assert_eq!(missing.provenance, FieldProvenance::Unknown);
assert!(missing.value.is_none());

Variants

Explicit

A person authored it, in the canonical record, under this key. The strongest thing that can be said about a value, and the only one that survives a rewrite of every derivation in this repository.

Derived

A machine worked it out from records or from git, by a rule that cannot be wrong about a repository it can read: an issue’s dependents are the issues that name it. Re-derived on every call and stored nowhere.

Inferred

A machine worked it out by a rule that can be wrong, because the relation it reads was never declared: a session belongs to an issue because its branch name contains the issue’s id. Useful, and never to be mistaken for a declaration.

Unknown

Not available. Either the record does not carry the key, or the fact lives outside what this process may read — a live GitHub state, for one — and the field says which in its reason. An unknown field never carries a value.

Implementations

impl FieldProvenance

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

The word a projection prints.

use majordomus_cli::devtask::FieldProvenance;
assert_eq!(FieldProvenance::Explicit.as_str(), "explicit");
assert_eq!(FieldProvenance::Unknown.as_str(), "unknown");

pub fn is_authored(self) -> bool

Did a person write this, in the canonical record?

use majordomus_cli::devtask::FieldProvenance;
assert!(FieldProvenance::Explicit.is_authored());
assert!(!FieldProvenance::Derived.is_authored());

Trait Implementations

impl Clone for FieldProvenance

fn clone(&self) -> FieldProvenance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FieldProvenance

impl Debug for FieldProvenance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FieldProvenance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FieldProvenance

impl Hash for FieldProvenance

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 JsonSchema for FieldProvenance

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 FieldProvenance

fn cmp(&self, other: &FieldProvenance) -> 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 FieldProvenance

fn eq(&self, other: &FieldProvenance) -> 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 FieldProvenance

fn partial_cmp(&self, other: &FieldProvenance) -> 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 FieldProvenance

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 FieldProvenance