Struct Holding 

pub struct Holding {
    pub kind: HoldingKind,
    pub identity: String,
    pub disposition: Disposition,
    pub evidence: String,
    pub remedy: String,
    pub at_risk: bool,
}

One thing holding work, and what is known about where that work can be reached from.

use majordomus_cli::convergence::{Disposition, Holding, HoldingKind};

let branch = Holding {
    kind: HoldingKind::Branch,
    identity: "feature/x".into(),
    disposition: Disposition::LocalOnly,
    evidence: "abc123 is on no remote-tracking ref of this checkout".into(),
    remedy: "git push -u origin feature/x".into(),
    at_risk: true,
};
// an at-risk holding always carries the command that would move it out of danger
assert!(branch.at_risk && !branch.remedy.is_empty());
// and a reachable one carries none, so the field is left out of the document
let safe = Holding { disposition: Disposition::Published, remedy: String::new(), at_risk: false, ..branch };
assert!(!serde_json::to_string(&safe).unwrap().contains("remedy"));

Fields

kind: HoldingKind

What kind of thing holds it.

identity: String

How it is named: a branch name, an absolute worktree path, a stash ref.

disposition: Disposition

Where the work can be reached from.

evidence: String

What was actually read — never a restatement of the disposition.

remedy: String

The command that would move it out of danger. Empty when it is not at risk.

at_risk: bool

This holding’s work exists on one disk only.

Trait Implementations

impl Clone for Holding

fn clone(&self) -> Holding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Holding

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Holding

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Holding

impl JsonSchema for Holding

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 Ordered for Holding

One collection, one order, declared once: at-risk holdings first (the group), then by kind in the order a worker meets them (a work tree, its branch, a stash), then by identity. Every surface that lists holdings shows this order, because none of them sorts.

fn order_key(&self) -> OrderKey<'_>

The four parts this item is ordered by. Borrowed from the item: building a key allocates nothing, so sorting a large collection costs the comparisons and no more.

impl PartialEq for Holding

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

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 Holding