Enum ReferenceResolution 

pub enum ReferenceResolution {
    Object,
    External,
    Historical,
    Missing,
}

How a typed reference resolved.

Four words and no fifth: a reference names an object of the index, or something only the ledger and git can vouch for, or a file the tree no longer holds and git history does, or nothing. external is not a weaker object — a commit or a task is exactly as real as a rule — it says which reader answered; historical resolves as well, and is named apart so a reader sees which provenance outlived its file (I1987).

use majordomus_cli::capability::builtin::knowledge_base::ReferenceResolution;
let r: ReferenceResolution = serde_json::from_str(r#""external""#).unwrap();
assert_eq!(r, ReferenceResolution::External);
assert!(r.resolves(), "vouched for by the ledger or git is resolved");
assert!(!ReferenceResolution::Missing.resolves());

Variants

Object

An object of the index: the target is its URI, or its path for a file.

External

Vouched for by the ledger, the task store or git: a session, a task, a decision, a commit.

Historical

A file: or test: the tree no longer holds and git history does: cited before the file was deleted, or pinned as file:<path>@<commit>. The target is the blob that answers, <commit>:<path>, which git show reads.

Missing

Nothing answers to it. A dangling reference is the integrity validator’s finding.

Implementations

impl ReferenceResolution

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

The word as serialised, for a text rendering that prints it beside the reference.

use majordomus_cli::capability::builtin::knowledge_base::ReferenceResolution;
assert_eq!(ReferenceResolution::External.as_str(), "external");
assert!(!ReferenceResolution::Missing.resolves());

pub fn resolves(self) -> bool

Whether something answered to the reference.

use majordomus_cli::capability::builtin::knowledge_base::ReferenceResolution;
assert!(ReferenceResolution::Object.resolves());
assert!(!ReferenceResolution::Missing.resolves());

Trait Implementations

impl Clone for ReferenceResolution

fn clone(&self) -> ReferenceResolution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ReferenceResolution

impl Debug for ReferenceResolution

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReferenceResolution

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReferenceResolution

impl JsonSchema for ReferenceResolution

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 ReferenceResolution

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

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

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

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 ReferenceResolution