monofs 0.2.1

`monofs` is an immutable distributed file system.
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
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

use std::{
    error::Error,
    fmt::{self, Display},
};

use monoutils_store::ipld::cid::Cid;
use thiserror::Error;

use crate::filesystem::Utf8UnixPathSegment;

//--------------------------------------------------------------------------------------------------
// Types
//--------------------------------------------------------------------------------------------------

/// The result of a file system operation.
pub type FsResult<T> = Result<T, FsError>;

/// An error that occurred during a file system operation.
#[derive(Debug, Error)]
pub enum FsError {
    /// Infallible error.
    #[error("Infallible error")]
    Infallible(#[from] core::convert::Infallible),

    /// Not a file.
    #[error("Not a file: {0:?}")]
    NotAFile(String),

    /// Not a directory.
    #[error("Not a directory: {0:?}")]
    NotADirectory(String),

    /// Not a softlink.
    #[error("Not a softlink: {0:?}")]
    NotASoftLink(String),

    /// Path not found.
    #[error("Path not found: {0}")]
    PathNotFound(String),

    // /// UCAN error.
    // #[error("UCAN error: {0}")]
    // Ucan(#[from] monoutils_ucan::UcanError),
    /// Custom error.
    #[error("Custom error: {0}")]
    Custom(#[from] AnyError),

    // /// DID related error.
    // #[error("DID error: {0}")]
    // Did(#[from] monoutils_did_wk::DidError),
    /// IPLD Store error.
    #[error("IPLD Store error: {0}")]
    IpldStore(#[from] monoutils_store::StoreError),

    /// Invalid deserialized OpenFlag value
    #[error("Invalid OpenFlag value: {0}")]
    InvalidOpenFlag(u8),

    /// Invalid deserialized EntityFlag value
    #[error("Invalid EntityFlag value: {0}")]
    InvalidEntityFlag(u8),

    /// Invalid deserialized PathFlag value
    #[error("Invalid PathFlag value: {0}")]
    InvalidPathFlag(u8),

    /// Invalid path component
    #[error("Invalid path component: {0}")]
    InvalidPathComponent(String),

    /// Invalid search path with root.
    #[error("Invalid search path: {0}")]
    InvalidSearchPath(String),

    /// SoftLink not supported yet.
    #[error("SoftLink not supported yet: path: {0:?}")]
    SoftLinkNotSupportedYet(Vec<Utf8UnixPathSegment>),

    /// Invalid search path empty.
    #[error("Invalid search path empty")]
    InvalidSearchPathEmpty,

    /// Unable to load entity.
    #[error("Unable to load entity: {0}")]
    UnableToLoadEntity(Cid),

    /// CID error.
    #[error("CID error: {0}")]
    CidError(#[from] monoutils_store::ipld::cid::Error),

    /// Path has root.
    #[error("Path has root: {0}")]
    PathHasRoot(String),

    /// Source is not a directory.
    #[error("Source is not a directory: {0}")]
    SourceIsNotADir(String),

    /// Target is not a directory.
    #[error("Target is not a directory: {0}")]
    TargetIsNotADir(String),

    /// Path is empty.
    #[error("Path is empty")]
    PathIsEmpty,

    /// Maximum follow depth reached.
    #[error("Maximum follow depth reached")]
    MaxFollowDepthReached,

    /// Broken softlink.
    #[error("Broken softlink: {0}")]
    BrokenSoftLink(Cid),
}

// /// Permission error.
// #[derive(Debug, Error)]
// pub enum PermissionError {
//     /// Child descriptor has higher permission than parent.
//     #[error("Child descriptor has higher permission than parent: path: {0}, parent(descriptor_flags: {1:?}) child (descriptor_flags: {2:?}, open_flags: {3:?})")]
//     ChildPermissionEscalation(Path, DescriptorFlags, DescriptorFlags, OpenFlags),
// }

/// An error that can represent any error.
#[derive(Debug)]
pub struct AnyError {
    error: anyhow::Error,
}

//--------------------------------------------------------------------------------------------------
// Methods
//--------------------------------------------------------------------------------------------------

impl FsError {
    /// Creates a new `Err` result.
    pub fn custom(error: impl Into<anyhow::Error>) -> FsError {
        FsError::Custom(AnyError {
            error: error.into(),
        })
    }
}

impl AnyError {
    /// Downcasts the error to a `T`.
    pub fn downcast<T>(&self) -> Option<&T>
    where
        T: Display + fmt::Debug + Send + Sync + 'static,
    {
        self.error.downcast_ref::<T>()
    }
}

//--------------------------------------------------------------------------------------------------
// Functions
//--------------------------------------------------------------------------------------------------

/// Creates an `Ok` `FsResult`.
#[allow(non_snake_case)]
pub fn Ok<T>(value: T) -> FsResult<T> {
    Result::Ok(value)
}

//--------------------------------------------------------------------------------------------------
// Trait Implementations
//--------------------------------------------------------------------------------------------------

impl PartialEq for AnyError {
    fn eq(&self, other: &Self) -> bool {
        self.error.to_string() == other.error.to_string()
    }
}

impl Display for AnyError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.error)
    }
}

impl Error for AnyError {}