qubit-fs 0.2.0

Provider-neutral synchronous and asynchronous filesystem abstraction for Rust
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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Filesystem error categories.

/// Provider-neutral filesystem error category.
///
/// # Examples
///
/// ```
/// use qubit_fs::error::FsError;
/// use qubit_fs::error::FsErrorKind;
/// use qubit_fs::error::FsOperation;
///
/// let error = FsError::new(FsErrorKind::NotFound, FsOperation::Stat, "missing object");
/// assert_eq!(FsErrorKind::NotFound, error.kind());
/// ```
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum FsErrorKind {
    /// The requested resource does not exist.
    NotFound,
    /// The target resource already exists.
    AlreadyExists,
    /// A path component expected to be a directory is not a directory.
    NotDirectory,
    /// The requested operation expected a file but found a directory.
    IsDirectory,
    /// A provider-local path is invalid for the selected filesystem.
    InvalidPath,
    /// A filesystem URI is malformed or violates the credential boundary.
    InvalidUri,
    /// Operation options or provider construction input are inconsistent.
    InvalidOptions,
    /// A provider returned a value that violates the SPI contract.
    ProviderContractViolation,
    /// The current credentials do not grant the requested operation.
    PermissionDenied,
    /// Authentication failed before authorization could be evaluated.
    AuthenticationFailed,
    /// The selected provider is unavailable in the current environment.
    ProviderUnavailable,
    /// The filesystem model does not support the requested operation.
    UnsupportedOperation,
    /// A specific stable filesystem capability is not supported.
    UnsupportedCapability,
    /// The operation exists but cannot satisfy a required semantic guarantee.
    RequirementNotMet,
    /// The handle or resource is not in a state that permits the operation.
    InvalidState,
    /// Side effects may have occurred, but their final state is unknown.
    Indeterminate,
    /// The operation was cancelled before a definitive result was produced.
    Cancelled,
    /// The operation conflicts with current filesystem state.
    Conflict,
    /// A conditional operation failed its precondition.
    PreconditionFailed,
    /// The operation timed out.
    Timeout,
    /// The operation was interrupted.
    Interrupted,
    /// A quota, capacity, or storage limit was exceeded.
    QuotaExceeded,
    /// A deterministic caller or provider resource bound was exceeded.
    ResourceLimitExceeded,
    /// Stored or transferred data failed integrity validation.
    DataCorruption,
    /// A lower-level local or remote I/O error occurred.
    Io,
    /// An error occurred that does not fit a more specific category.
    Other,
}