weavatrix-worktree 0.2.0

Bounded, crash-recoverable multi-file worktree edits for source refactoring
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

mod commit;
mod lock;
mod plan;
mod prepare;
mod recovery;
mod recovery_model;
#[cfg(test)]
mod recovery_tests;
mod rollback;
mod stage;
mod stage_cleanup;
mod util;
mod verify;

use crate::{
    filesystem::ControlDir, journal::JournalWriter, options::WorktreeOptions, report::DryRunReport,
};

use stage::StagedFile;

/// A durably staged transaction holding the exclusive worktree lock.
#[must_use = "commit, abort, or later recover the prepared transaction"]
pub struct PreparedTransaction {
    transaction_id: String,
    operation: String,
    preview: DryRunReport,
    files: Vec<StagedFile>,
    options: WorktreeOptions,
    journal: JournalWriter,
    control: ControlDir,
    _lock: std::fs::File,
}

impl core::fmt::Debug for PreparedTransaction {
    fn fmt(&self, formatter: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        formatter
            .debug_struct("PreparedTransaction")
            .field("transaction_id", &self.transaction_id)
            .field("operation", &self.operation)
            .field("prepared_files", &self.files.len())
            .finish_non_exhaustive()
    }
}

impl PreparedTransaction {
    #[must_use]
    pub fn transaction_id(&self) -> &str {
        &self.transaction_id
    }

    #[must_use]
    pub const fn preview(&self) -> &DryRunReport {
        &self.preview
    }
}

pub(crate) use lock::acquire;
pub(crate) use plan::{dry_run_report, project_plan};
pub(crate) use prepare::prepare_transaction;
pub(crate) use recovery::recover_transaction;