lux-lib 0.65.0

Library for the lux package manager for Lua
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

use std::{
    fs::{self, DirEntry},
    path::{Path, PathBuf},
};

use super::FsError;

/// Wrapped [`fs::read_to_string`].
pub(crate) fn read_to_string(path: impl AsRef<Path>) -> Result<String, FsError> {
    let path = path.as_ref();
    fs::read_to_string(path).map_err(|source| FsError::ReadToString {
        path: path.to_path_buf(),
        source,
    })
}

/// Wrapped [`fs::write`].
pub(crate) fn write(path: impl AsRef<Path>, contents: impl AsRef<[u8]>) -> Result<(), FsError> {
    let path = path.as_ref();
    fs::write(path, contents).map_err(|source| FsError::Write {
        path: path.to_path_buf(),
        source,
    })
}

/// Wrapped [`fs::copy`].
pub(crate) fn copy(from: impl AsRef<Path>, to: impl AsRef<Path>) -> Result<u64, FsError> {
    let from = from.as_ref();
    let to = to.as_ref();
    fs::copy(from, to).map_err(|source| FsError::Copy {
        from: from.to_path_buf(),
        to: to.to_path_buf(),
        source,
    })
}

/// Wrapped [`fs::create_dir_all`].
pub(crate) fn create_dir_all(path: impl AsRef<Path>) -> Result<(), FsError> {
    let path = path.as_ref();
    fs::create_dir_all(path).map_err(|source| FsError::CreateDirAll {
        path: path.to_path_buf(),
        source,
    })
}

/// Wrapped [`fs::remove_file`].
pub(crate) fn remove_file(path: impl AsRef<Path>) -> Result<(), FsError> {
    let path = path.as_ref();
    fs::remove_file(path).map_err(|source| FsError::RemoveFile {
        path: path.to_path_buf(),
        source,
    })
}

/// Wrapped [`fs::remove_dir_all`].
pub(crate) fn remove_dir_all(path: impl AsRef<Path>) -> Result<(), FsError> {
    let path = path.as_ref();
    fs::remove_dir_all(path).map_err(|source| FsError::RemoveDirAll {
        path: path.to_path_buf(),
        source,
    })
}

/// Wrapped [`fs::read_dir`].
pub(crate) fn read_dir(
    path: impl AsRef<Path>,
) -> Result<impl Iterator<Item = Result<DirEntry, FsError>>, FsError> {
    let path = path.as_ref();
    fs::read_dir(path)
        .map_err(|source| FsError::ReadDir {
            path: path.to_path_buf(),
            source,
        })
        .map(|entries| {
            let path = path.to_path_buf();

            entries.map(move |entry| {
                entry.map_err(|source| FsError::ReadDir {
                    path: path.clone(),
                    source,
                })
            })
        })
}

/// Wrapped [`fs::File::open`].
pub(crate) fn open(path: impl AsRef<Path>) -> Result<fs::File, FsError> {
    let path = path.as_ref();
    fs::File::open(path).map_err(|source| FsError::FileOpen {
        path: path.to_path_buf(),
        source,
    })
}

/// Wrapped [`fs::File::create`].
pub(crate) fn create(path: impl AsRef<Path>) -> Result<fs::File, FsError> {
    let path = path.as_ref();
    fs::File::create(path).map_err(|source| FsError::FileCreate {
        path: path.to_path_buf(),
        source,
    })
}

/// Wrapped [`std::path::absolute`].
pub(crate) fn absolute(path: impl AsRef<Path>) -> Result<PathBuf, FsError> {
    let path = path.as_ref();
    std::path::absolute(path).map_err(|source| FsError::GetAbsolutePath {
        path: path.to_path_buf(),
        source,
    })
}