maudit 0.11.0

Library for generating static websites.
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

//! Error types for Maudit.
use std::fmt::{self, Debug, Formatter};
use std::path::PathBuf;
use thiserror::Error;

macro_rules! impl_debug_for_error {
    ($($t:ty),*) => {
        $(
            impl Debug for $t {
                fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
                    // Rust's uses the Debug trait to show errors when they're returned from main
                    // But, thiserror uses the Display trait to show errors. This redirects Debug to Display, essentially.
                    // TODO: Take over error rendering completely when using coronate
                    write!(f, "{}", self)
                }
            }
        )*
    };
}

#[derive(Error)]
pub enum UrlError {
    // TODO: Add contextual information and more details
    #[error("Route not found")]
    RouteNotFound,
}

#[derive(Error)]
pub enum BuildError {
    #[error(
        "`{route}` returns `RenderResult::Raw`, but includes styles or scripts, which can only be included in HTML. If you meant to return HTML, use `RenderResult::Text` instead. Alternatively, if you meant to add a reference to a script or style without including it directly, use the  `add_script` or `add_style` methods instead."
    )]
    InvalidRenderResult { route: String },
}

#[derive(Error)]
pub enum AssetError {
    #[error("Failed to read asset file: {path}")]
    ReadFailed {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },
    #[error("Failed to get metadata for asset file: {path}")]
    MetadataFailed {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },
    #[error("Failed to canonicalize asset path: {path}")]
    CanonicalizeFailed {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },
    #[error("Failed to copy CSS-referenced asset {source_path} to {dest_path}")]
    CopyFailed {
        source_path: PathBuf,
        dest_path: PathBuf,
        #[source]
        source: std::io::Error,
    },
    #[error("Failed to load image for placeholder generation: {path}")]
    ImageLoadFailed {
        path: PathBuf,
        #[source]
        source: image::ImageError,
    },
}

#[derive(Error, Debug)]
pub enum MauditError {
    #[error(transparent)]
    Asset(#[from] AssetError),

    #[error(transparent)]
    Url(#[from] UrlError),

    #[error(transparent)]
    Build(#[from] BuildError),

    #[error(transparent)]
    Io(#[from] std::io::Error),
}

impl_debug_for_error!(UrlError, BuildError, AssetError);