logfs 0.1.1

Simple append-only log based filesystem with encryption and compression
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

#[derive(Debug)]
pub enum LogFsError {
    ReadOnly,
    NotFound {
        path: super::Path,
    },
    Internal {
        message: String,
        backtrace: backtrace::Backtrace,
    },
    Io {
        error: std::io::Error,
        backtrace: backtrace::Backtrace,
    },
    Conversion(bincode::Error),
    Tainted,
    WriterClosed,
}

impl LogFsError {
    pub(crate) fn new_internal(msg: impl Into<String>) -> Self {
        Self::Internal {
            message: msg.into(),
            backtrace: backtrace::Backtrace::new(),
        }
    }

    pub(crate) fn into_io(self) -> std::io::Error {
        match self {
            LogFsError::Io { error, .. } => error,
            other => std::io::Error::other(other),
        }
    }
}

impl std::fmt::Display for LogFsError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            LogFsError::Internal { message, .. } => {
                write!(f, "{}", message)
            }
            LogFsError::Io { error, .. } => error.fmt(f),
            LogFsError::Conversion(err) => err.fmt(f),
            LogFsError::NotFound { path } => {
                write!(f, "File not found: {:?}", path)
            }
            LogFsError::Tainted => write!(
                f,
                "The database is tainted and can not be used for writes until re-initialization."
            ),
            LogFsError::WriterClosed => write!(f, "Log was closed for writes"),
            LogFsError::ReadOnly => write!(f, "Could not insert: log is read-only"),
        }
    }
}

impl std::error::Error for LogFsError {
    fn cause(&self) -> Option<&dyn std::error::Error> {
        match self {
            LogFsError::Internal { .. } => None,
            LogFsError::Io { error, .. } => Some(error),
            LogFsError::Conversion(err) => Some(err),
            LogFsError::NotFound { path: _ } => None,
            LogFsError::Tainted => None,
            LogFsError::WriterClosed => None,
            LogFsError::ReadOnly => None,
        }
    }
}

impl From<std::io::Error> for LogFsError {
    #[track_caller]
    fn from(error: std::io::Error) -> Self {
        Self::Io {
            error,
            backtrace: backtrace::Backtrace::new(),
        }
    }
}

impl From<bincode::Error> for LogFsError {
    fn from(err: bincode::Error) -> Self {
        Self::Conversion(err)
    }
}