Struct Recovery 

pub struct Recovery {
    pub present: bool,
    pub pointer: Pointer,
    pub stranded: Vec<Stranded>,
    pub orphans: Vec<Orphan>,
    pub balance: Balance,
    pub findings: Vec<String>,
}

What this checkout’s session store needs somebody to do.

findings is the whole report said once, and an empty findings is the verdict: there is nothing to recover. That is the field to branch on — the three detailed lists and the arithmetic are what a reader consults after deciding there is something to look at, and each of them can be empty for a good reason while another is not.

use majordomus_cli::capability::builtin::lifecycle::Recovery;
use serde_json::json;

// a healthy checkout: the current layout, nothing stranded, the arithmetic agreeing
let clean: Recovery = serde_json::from_value(json!({
    "present": true,
    "pointer": {"layout": "pointer", "target": "sessions-open/c.yaml",
                "resolves": true, "session_id": "s-1", "note": "resolves"},
    "balance": {"started": 8, "closed": 7, "open": 1,
                "unaccounted": 0, "agrees": true, "note": "they agree"},
})).unwrap();

assert!(clean.findings.is_empty(), "an empty findings list is the good verdict");
assert!(clean.stranded.is_empty() && clean.orphans.is_empty());
assert!(clean.balance.agrees);

// a fresh clone has no local half at all, which is also nothing to recover
let fresh: Recovery = serde_json::from_value(json!({
    "present": false,
    "pointer": {"layout": "absent", "resolves": false, "note": "no episode is open here"},
    "balance": {"started": 0, "closed": 0, "open": 0,
                "unaccounted": 0, "agrees": true, "note": "nothing has happened yet"},
})).unwrap();
assert!(!fresh.present && fresh.findings.is_empty());

Fields

present: bool

Whether the local half exists at all.

pointer: Pointer

The pointer and its layout.

stranded: Vec<Stranded>

Episodes that can no longer close themselves.

orphans: Vec<Orphan>

Temporary files left in the tracked sessions section.

balance: Balance

The started/closed/open arithmetic.

findings: Vec<String>

Everything above, said once, for a reader that wants the summary. Empty is the good case and means there is nothing to recover.

Trait Implementations

impl Clone for Recovery

fn clone(&self) -> Recovery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Recovery

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Recovery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Recovery

impl JsonSchema for Recovery

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 Recovery

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

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 Recovery