lux-lib 0.54.2

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
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

use miette::Diagnostic;
use thiserror::Error;

pub mod sync;
pub mod tempfile;
pub mod tokio;

#[derive(Debug, Error, Diagnostic)]
#[non_exhaustive]
pub enum FsError {
    #[error("failed to read file '{}'", path.display())]
    #[diagnostic(
        code(lux_lib::fs::read),
        help("ensure '{}' exists and is readable", path.display())
    )]
    Read {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to read '{}' as UTF-8 string", path.display())]
    #[diagnostic(
        code(lux_lib::fs::read_to_string),
        help("ensure '{}' exists, is readable, and contains valid UTF-8", path.display())
    )]
    ReadToString {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to write to '{}'", path.display())]
    #[diagnostic(
        code(lux_lib::fs::write),
        help("ensure the parent directory of '{}' exists and is writable", path.display())
    )]
    Write {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to copy '{}' to '{}'", from.display(), to.display())]
    #[diagnostic(
        code(lux_lib::fs::copy),
        help("ensure '{}' exists and the parent directory of '{}' is writable", from.display(), to.display())
    )]
    Copy {
        from: std::path::PathBuf,
        to: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to create directory '{}'", path.display())]
    #[diagnostic(
        code(lux_lib::fs::create_dir),
        help("ensure the parent directory of '{}' exists and is writable", path.display())
    )]
    CreateDir {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to create a temporaty directory")]
    #[diagnostic(
        code(lux_lib::fs::create_tempdir),
        help("ensure the '{}' exists and is writable", std::env::temp_dir().display())
    )]
    CreateTempDir { source: std::io::Error },
    #[error("failed to create directory tree '{}'", path.display())]
    #[diagnostic(
        code(lux_lib::fs::create_dir_all),
        help("ensure the path to '{}' is accessible", path.display())
    )]
    CreateDirAll {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to remove file '{}'", path.display())]
    #[diagnostic(
        code(lux_lib::fs::remove_file),
        help("ensure '{}' exists and is writable", path.display())
    )]
    RemoveFile {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to remove directory '{}'", path.display())]
    #[diagnostic(
        code(lux_lib::fs::remove_dir_all),
        help("ensure '{}' exists and is writable", path.display())
    )]
    RemoveDirAll {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to read directory '{}'", path.display())]
    #[diagnostic(
        code(lux_lib::fs::read_dir),
        help("ensure '{}' exists and is a directory", path.display())
    )]
    ReadDir {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to get metadata for '{}'", path.display())]
    #[diagnostic(
        code(lux_lib::fs::metadata),
        help("ensure '{}' exists", path.display())
    )]
    Metadata {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to rename '{}' to '{}'", from.display(), to.display())]
    #[diagnostic(
        code(lux_lib::fs::rename),
        help("ensure '{}' exists and the parent directory of '{}' is writable", from.display(), to.display())
    )]
    Rename {
        from: std::path::PathBuf,
        to: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to set permissions on '{}'", path.display())]
    #[diagnostic(
        code(lux_lib::fs::set_permissions),
        help("ensure '{}' exists and is writable", path.display())
    )]
    SetPermissions {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to open file '{}'", path.display())]
    #[diagnostic(
        code(lux_lib::fs::file_open),
        help("ensure '{}' exists and is readable", path.display())
    )]
    FileOpen {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("failed to create file '{}'", path.display())]
    #[diagnostic(
        code(lux_lib::fs::file_create),
        help("ensure the parent directory of '{}' exists and is writable", path.display())
    )]
    FileCreate {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
}