Struct Orphan 

pub struct Orphan {
    pub path: String,
    pub bytes: u64,
}

A temporary file left in a record directory by a close that did not finish.

The close path writes the durable record to .tmp.XXXX in the destination directory and renames it, so that no reader ever sees half a record. A process killed between the two leaves the temporary file behind, where it is untracked, invisible to every reader of the section, and — because the directory is tracked — offered to the next git add ..

bytes is carried because it is the one thing that decides what to do with the file: a zero-length temporary file is a close that died before it wrote anything and can simply go, while a large one is a record that was written and never renamed, and is worth reading before it is deleted.

use majordomus_cli::capability::builtin::lifecycle::Orphan;
use majordomus_cli::order::canonical;

let mut orphans = vec![
    Orphan { path: ".ai/repo/project/sessions/.tmp.b2".into(), bytes: 4_812 },
    Orphan { path: ".ai/repo/project/sessions/.tmp.a1".into(), bytes: 0 },
];
canonical(&mut orphans);

// filed under the path, which names one file and so makes the list total
let paths: Vec<&str> = orphans.iter().map(|o| o.path.as_str()).collect();
assert_eq!(paths, [
    ".ai/repo/project/sessions/.tmp.a1",
    ".ai/repo/project/sessions/.tmp.b2",
]);

// and the size is what tells a dead stub from a record that was written
assert_eq!(orphans[0].bytes, 0, "nothing was written before the close died");
assert!(orphans[1].bytes > 0, "read this one before removing it");

Fields

path: String

Repository-relative path.

bytes: u64

Its size in bytes, which is how a reader tells an empty stub from a lost record.

Trait Implementations

impl Clone for Orphan

fn clone(&self) -> Orphan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Orphan

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Orphan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Orphan

impl JsonSchema for Orphan

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 Orphan

A path names one file, so it is both what a reader looks for and the identity that makes the orphan list total.

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 Orphan

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

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 Orphan