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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
// =============================================================================
// Copyright (c) 2026 Haixing Hu.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Synchronous provider implementation contract.
use super::CopyAttempt;
use super::CopyDeclineReason;
use super::CopyRequest;
use super::CreateDirectoryRequest;
use super::CreateTempDirectoryRequest;
use super::CreateTempFileRequest;
use super::DeleteDirectoryRequest;
use super::DeleteFileRequest;
use super::ListRequest;
use super::OpenReaderRequest;
use super::OpenWriterRequest;
use super::OpenedDirectoryStream;
use super::OpenedReader;
use super::OpenedTempDirectory;
use super::OpenedTempFile;
use super::OpenedWriter;
use super::ProviderProperties;
use super::RenameRequest;
use super::SpiCopyFailure;
use super::SpiRenameFailure;
use super::StatRequest;
use super::StatResponse;
use crate::directory::CreateDirectoryOutcome;
use crate::directory::DeleteOutcome;
use crate::error::FsEffectState;
use crate::error::FsError;
use crate::error::FsErrorKind;
use crate::error::FsOperation;
use crate::error::FsResult;
use crate::rename::RenameFailureState;
use crate::rename::RenameOutcome;
/// Synchronous provider implementation contract.
///
/// # Examples
///
/// ```
/// use qubit_fs::spi::FileSystemSpi;
///
/// fn accepts_provider<T: FileSystemSpi>() {}
/// ```
pub trait FileSystemSpi: Send + Sync {
/// Returns one immutable property snapshot.
///
/// # Returns
/// The provider's immutable property snapshot.
fn properties(&self) -> ProviderProperties;
/// Reads metadata for a validated request.
///
/// # Parameters
/// - `request`: Facade-validated stat request.
///
/// # Returns
/// Path-bound provider metadata.
///
/// # Errors
/// Returns the provider lookup failure with filesystem context.
fn stat(&self, request: StatRequest<'_>) -> FsResult<StatResponse>;
/// Opens a directory stream.
///
/// # Parameters
/// - `request`: Facade-validated list request.
///
/// # Returns
/// An opened provider enumeration session.
///
/// # Errors
/// Returns the provider open failure with filesystem context.
fn list(&self, request: ListRequest<'_>) -> FsResult<OpenedDirectoryStream> {
Err(match request.scope().path() {
Some(path) => unsupported(FsOperation::List, path),
None => FsError::new(
FsErrorKind::UnsupportedOperation,
FsOperation::List,
"provider operation is not supported",
),
})
}
/// Opens a reader.
///
/// # Parameters
/// - `request`: Facade-validated reader request.
///
/// # Returns
/// An identity-bound provider reader.
///
/// # Errors
/// Returns the provider open failure with filesystem context.
fn open_reader(&self, request: OpenReaderRequest<'_>) -> FsResult<OpenedReader> {
Err(unsupported(FsOperation::OpenReader, request.path()))
}
/// Opens a writer.
///
/// An unsuccessful open must describe its external effects. Attach
/// `FsEffectState::Unchanged` only when no mutation occurred and no cleanup
/// responsibility remains. Missing evidence is conservatively indeterminate
/// in aggregate operations, including an `AlreadyExists` skip request.
///
/// # Parameters
/// - `request`: Facade-validated writer request.
///
/// # Returns
/// An identity-bound provider writer.
///
/// # Errors
/// Returns the provider open failure with filesystem context.
fn open_writer(&self, request: OpenWriterRequest<'_>) -> FsResult<OpenedWriter> {
Err(unsupported(FsOperation::OpenWriter, request.path()).with_effect_state(FsEffectState::Unchanged))
}
/// Creates a directory.
///
/// # Parameters
/// - `request`: Facade-validated directory-creation request.
///
/// # Returns
/// The confirmed creation outcome.
///
/// # Errors
/// Returns the provider creation failure with filesystem context.
fn create_directory(&self, request: CreateDirectoryRequest<'_>) -> FsResult<CreateDirectoryOutcome> {
Err(unsupported(FsOperation::CreateDir, request.path()))
}
/// Deletes a file.
///
/// # Parameters
/// - `request`: Facade-validated file-deletion request.
///
/// # Returns
/// The confirmed deletion outcome.
///
/// # Errors
/// Returns the provider deletion failure with filesystem context.
fn delete_file(&self, request: DeleteFileRequest<'_>) -> FsResult<DeleteOutcome> {
Err(unsupported(FsOperation::Delete, request.path()))
}
/// Deletes a directory.
///
/// # Parameters
/// - `request`: Facade-validated directory-deletion request.
///
/// # Returns
/// The confirmed deletion outcome.
///
/// # Errors
/// Returns the provider deletion failure with filesystem context.
fn delete_directory(&self, request: DeleteDirectoryRequest<'_>) -> FsResult<DeleteOutcome> {
Err(unsupported(FsOperation::Delete, request.path()))
}
/// Attempts an optional provider copy primitive.
///
/// # Parameters
/// - `_request`: Facade-validated copy request.
///
/// # Returns
/// A completed outcome or a typed decline reason.
///
/// # Errors
/// Returns a typed failure preserving confirmed publication progress.
#[inline]
fn try_copy(&self, _request: CopyRequest<'_>) -> Result<CopyAttempt, SpiCopyFailure> {
Ok(CopyAttempt::Declined(CopyDeclineReason::NotImplemented))
}
/// Renames a resource.
///
/// # Parameters
/// - `request`: Facade-validated rename request.
///
/// # Returns
/// The confirmed rename outcome.
///
/// # Errors
/// Returns a typed failure preserving confirmed rename progress.
fn rename(&self, request: RenameRequest<'_>) -> Result<RenameOutcome, SpiRenameFailure> {
Err(SpiRenameFailure::new(
unsupported(FsOperation::Rename, request.source()).with_target(request.target().clone()),
RenameFailureState::Unchanged,
))
}
/// Creates a temporary file.
///
/// # Parameters
/// - `request`: Validated temporary-file creation request.
///
/// # Returns
/// An identity-bound temporary-file session.
///
/// # Errors
/// Returns the provider creation failure with filesystem context.
fn create_temp_file(&self, _request: CreateTempFileRequest) -> FsResult<OpenedTempFile> {
Err(FsError::new(
FsErrorKind::UnsupportedOperation,
FsOperation::CreateTemp,
"provider does not implement this operation",
))
}
/// Creates a temporary directory.
///
/// # Parameters
/// - `request`: Validated temporary-directory creation request.
///
/// # Returns
/// An identity-bound temporary-directory session.
///
/// # Errors
/// Returns the provider creation failure with filesystem context.
fn create_temp_directory(&self, _request: CreateTempDirectoryRequest) -> FsResult<OpenedTempDirectory> {
Err(FsError::new(
FsErrorKind::UnsupportedOperation,
FsOperation::CreateTemp,
"provider does not implement this operation",
))
}
}
/// Builds a standard unsupported-operation error for a validated path request.
fn unsupported(operation: FsOperation, path: &crate::path::Path) -> FsError {
FsError::new(
FsErrorKind::UnsupportedOperation,
operation,
"provider does not implement this operation",
)
.with_path(path.clone())
}