buntrail-core 0.2.0

Revisioned documents and shared editor contracts.
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

use super::*;
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum MutationKind {
    Save,
    File,
    Git,
    TerminalOpen,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum ExpectedState {
    File {
        file: FileRef,
        version: Option<FileVersion>,
    },
    Git {
        worktree: WorktreeIdentity,
        state: GitExpectedState,
    },
    Runtime(RuntimeGeneration),
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct OperationEnvelope {
    pub id: OperationID,
    pub target: TargetIdentity,
    pub request_digest: [u8; 32],
    pub kind: MutationKind,
    pub expected: ExpectedState,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum MutationResult {
    Saved(SaveResult),
    FileChanged {
        file: FileRef,
        version: Option<FileVersion>,
    },
    GitChanged {
        worktree: WorktreeIdentity,
        state: GitExpectedState,
        #[serde(default, skip_serializing_if = "Option::is_none")]
        outcome: Option<Box<RepositoryOutcome>>,
    },
    TerminalOpened {
        session: TerminalSessionID,
        runtime: RuntimeGeneration,
    },
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum ObservedState {
    Unobserved,
    File {
        file: FileRef,
        version: Option<FileVersion>,
        digest: Option<[u8; 32]>,
    },
    Git {
        worktree: WorktreeIdentity,
        state: GitExpectedState,
    },
    GitNetwork {
        worktree: WorktreeIdentity,
        state: GitExpectedState,
        intent: GitNetworkIntent,
        observation: Option<GitNetworkObservation>,
    },
    Runtime(RuntimeGeneration),
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct ReconciliationEvidence {
    pub target: TargetIdentity,
    pub observed: ObservedState,
    pub explanation: String,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum FailureEffect {
    ProvenNoEffect,
    PossiblePartialEffects,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct OperationFailure {
    pub error: CoreError,
    pub target: TargetIdentity,
    pub observed: ObservedState,
    pub effect: FailureEffect,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum OperationState {
    Accepted,
    Running,
    Confirmed(MutationResult),
    Failed(OperationFailure),
    Unknown(ReconciliationEvidence),
}
impl OperationState {
    pub fn allows_automatic_replay(&self) -> bool {
        false
    }
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct OperationReceipt {
    pub id: OperationID,
    pub state: OperationState,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum OperationEvent {
    Started,
    Confirmed(MutationResult),
    Failed(OperationFailure),
    LostAcknowledgement(ReconciliationEvidence),
    Reconciled(MutationResult),
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
pub enum CancellationOutcome {
    ConfirmedCancel,
    TooLate,
    Unknown,
}