static-serve-macro 0.6.0

A helper for compressing and embedding static assets in an Axum webserver
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

use std::{
    ffi::{OsStr, OsString},
    fmt::{Display, Formatter},
    io,
};

use glob::{GlobError, PatternError};
use thiserror::Error;

#[derive(Debug, Error)]
pub(crate) enum Error {
    #[error("{}", UnknownFileExtension(.0.as_deref()))]
    UnknownFileExtension(Option<OsString>),
    #[error("File extension for file {} is not valid unicode", 0.to_string())]
    InvalidFileExtension(OsString),
    #[error("Cannot canonicalize assets directory")]
    CannotCanonicalizeDirectory(#[source] io::Error),
    #[error("Cannot canonicalize asset file")]
    CannotCanonicalizeFile(#[source] io::Error),
    #[error("File path is not utf-8")]
    FilePathIsNotUtf8,
    #[error("Invalid unicode in directory name")]
    InvalidUnicodeInDirectoryName,
    #[error("Cannot canonicalize ignore path")]
    CannotCanonicalizeIgnorePath(#[source] io::Error),
    #[error("Invalid unicode in entry name")]
    InvalidUnicodeInEntryName,
    #[error("Error while compressing with gzip")]
    Gzip(#[from] GzipType),
    #[error("Error while compressing with zstd")]
    Zstd(#[from] ZstdType),
    #[error("Error while reading entry contents")]
    CannotReadEntryContents(#[source] io::Error),
    #[error("Error while parsing glob pattern")]
    Pattern(#[source] PatternError),
    #[error("Error reading path for glob")]
    Glob(#[source] GlobError),
    #[error("Cannot get entry metadata")]
    CannotGetMetadata(#[source] io::Error),
    #[error("Cannot canonicalize directory for cache-busting")]
    CannotCanonicalizeCacheBustedDir(#[source] io::Error),
}

struct UnknownFileExtension<'a>(Option<&'a OsStr>);
impl Display for UnknownFileExtension<'_> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self.0 {
            Some(ext) => write!(
                f,
                "Unknown file extension in directory of static assets: {}",
                ext.to_string_lossy()
            ),
            None => write!(f, "Missing file extension"),
        }
    }
}

#[derive(Debug, Error)]
pub(crate) enum GzipType {
    #[error("The compressor could not write")]
    CompressorWrite(#[source] io::Error),
    #[error("The encoder could not complete the `finish` procedure")]
    EncoderFinish(#[source] io::Error),
}

#[derive(Debug, Error)]
pub(crate) enum ZstdType {
    #[error("The encoder could not write")]
    EncoderWrite(#[source] io::Error),
    #[error("The encoder could not complete the `finish` procedure")]
    EncoderFinish(#[source] io::Error),
}

#[cfg(test)]
mod test {
    use std::ffi::OsStr;

    use super::UnknownFileExtension;

    #[test]
    fn unknown_file_extension() {
        let missing_extension = UnknownFileExtension(None);
        assert_eq!(missing_extension.to_string(), "Missing file extension");
        let unknown_extension = UnknownFileExtension(Some(OsStr::new("pippo")));
        assert_eq!(
            unknown_extension.to_string(),
            "Unknown file extension in directory of static assets: pippo"
        );
    }
}