Struct AttestedText 

pub struct AttestedText {
    pub value: Option<String>,
    pub provenance: FieldProvenance,
    pub source: String,
    pub reason: Option<String>,
}

One scalar with its provenance: the unit every field of a development task is made of.

The invariant the constructors enforce, and AttestedText::is_consistent states, is that a value is present exactly when the provenance is not FieldProvenance::Unknown. Without it the shape can express “unknown, and here is the value”, which is the defect this whole module exists to prevent.

Fields

value: Option<String>

The value, absent exactly when the provenance is unknown.

provenance: FieldProvenance

Where it came from.

source: String

The one place a reader goes to check it: a repository-relative path with the key it was read from, a capability id, or a command. Never a machine path.

reason: Option<String>

Why the provenance is what it is, when that is worth a sentence: always for unknown and for inferred, and omitted otherwise.

Implementations

impl AttestedText

pub fn explicit(value: impl Into<String>, source: impl Into<String>) -> Self

A value the canonical record carried under this key.

pub fn derived(value: impl Into<String>, source: impl Into<String>) -> Self

A value worked out by a rule that cannot be wrong about a readable repository.

pub fn inferred( value: impl Into<String>, source: impl Into<String>, reason: impl Into<String>, ) -> Self

A value worked out by a rule that can be wrong, with the rule stated.

pub fn unknown(source: impl Into<String>, reason: impl Into<String>) -> Self

No value, and why there is none.

pub fn text(&self) -> &str

The value, or the empty string. For a renderer; never for a decision.

pub fn is_consistent(&self) -> bool

Is the invariant held: a value present exactly when the provenance is not unknown?

use majordomus_cli::devtask::AttestedText;
assert!(AttestedText::explicit("x", "s").is_consistent());
assert!(AttestedText::unknown("s", "why").is_consistent());

Trait Implementations

impl Clone for AttestedText

fn clone(&self) -> AttestedText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AttestedText

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AttestedText

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AttestedText

impl JsonSchema for AttestedText

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 PartialEq for AttestedText

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

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 AttestedText