buntrail-core 0.1.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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

use super::*;
use std::sync::Arc;
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct FileRef {
    pub target: TargetIdentity,
    pub path: TargetPath,
    pub resolved_identity: Option<Vec<u8>>,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct FileVersion {
    pub target: TargetIdentity,
    pub opaque_token: Vec<u8>,
    pub content_digest: [u8; 32],
    pub file_identity: Vec<u8>,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum ByteSource {
    Memory(Arc<[u8]>),
    PrivateSpool {
        local_path: TargetPath,
        length: u64,
        digest: [u8; 32],
        /// Pure lifetime token; filesystem cleanup runs in the service worker.
        #[serde(skip)]
        lease: Option<Arc<()>>,
    },
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct FileSnapshot {
    pub file: FileRef,
    pub version: FileVersion,
    pub size: u64,
    pub encoding: Encoding,
    pub source: ByteSource,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum FileKind {
    File,
    Directory,
    Symlink,
    Other,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct FileEntry {
    pub file: FileRef,
    pub display_name: String,
    pub kind: FileKind,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum FileEvent {
    Changed(FileRef),
    Removed(FileRef),
    RescanRequired(FileRef),
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct SaveRequest {
    pub operation: OperationID,
    pub file: FileRef,
    pub expected_version: Option<FileVersion>,
    pub submitted_revision: BufferRevision,
    pub source: ByteSource,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct SaveResult {
    pub saved_revision: BufferRevision,
    pub version: FileVersion,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum FileMutation {
    Create {
        source: ByteSource,
    },
    Rename {
        destination: TargetPath,
    },
    Move {
        destination: TargetPath,
    },
    Delete,
    /// Remove a file or empty directory; never descend into a directory.
    Remove,
    CreateDirectory,
    Trash,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum ExpectedPathState {
    Absent,
    Present(FileVersion),
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct FileMutationRequest {
    pub operation: OperationID,
    pub file: FileRef,
    pub expected: ExpectedPathState,
    pub command: FileMutation,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum SearchMode {
    Literal,
    Regex,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct SearchRequest {
    pub request: RequestId,
    pub root: FileRef,
    pub expression: String,
    pub mode: SearchMode,
    pub case_sensitive: bool,
    pub whole_word: bool,
    pub includes: Vec<String>,
    pub excludes: Vec<String>,
    pub hidden: bool,
    pub ignored: bool,
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct SearchMatch {
    pub file: FileRef,
    pub line: u64,
    pub preview_column_utf8: u64,
    pub preview: String,
    pub searched_version: FileVersion,
    pub searched_digest: [u8; 32],
}
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, PartialEq, Eq)]
pub enum SearchEvent {
    Match(Box<SearchMatch>),
    Progress { files: u64, matches: u64 },
    Complete,
    Cancelled,
    Limited { maximum: u64 },
    Failed(CoreError),
}

/// Root resolution follows the root directory; child intents retain the requested alias.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum FileResolvePurpose {
    Root,
    OpenChild(TargetPath),
    MutationNode(TargetPath),
}
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct FileResolution {
    pub root: FileRef,
    pub file: FileRef,
    pub resolved_path: TargetPath,
    /// Kind of the observed node (a leaf symlink stays a symlink).
    pub kind: Option<FileKind>,
    /// Only present when the existing strong version policy actually observed it.
    pub version: Option<FileVersion>,
}