kxio 1.1.2

Provides injectable Filesystem and Network resources to make code more testable
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

use std::path::PathBuf;

use derive_more::From;

use crate::fs::like::FileSystemLike;

mod like;
mod real;
mod temp;

#[derive(Debug, From, derive_more::Display)]
pub enum Error {
    Io(std::io::Error),

    #[display("Path access attempted outside of base ({base:?}): {path:?}")]
    PathTraversal {
        base: PathBuf,
        path: PathBuf,
    },
}
impl std::error::Error for Error {}

pub type Result<T> = core::result::Result<T, Error>;

pub const fn new(base: PathBuf) -> FileSystem {
    FileSystem::Real(real::new(base))
}

pub fn temp() -> Result<FileSystem> {
    temp::new().map(FileSystem::Temp)
}

#[derive(Clone, Debug)]
pub enum FileSystem {
    Real(real::RealFileSystem),
    Temp(temp::TempFileSystem),
}
impl std::ops::Deref for FileSystem {
    type Target = dyn FileSystemLike;

    fn deref(&self) -> &Self::Target {
        match self {
            Self::Real(fs) => fs,
            Self::Temp(fs) => fs.deref(),
        }
    }
}