hauchiwa 0.21.0

Flexible static website generator library with incremental rebuilds and cached image optimization
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

use std::sync::Arc;
#[cfg(feature = "live")]
use std::sync::mpsc::{RecvError, SendError};

pub use anyhow::Error as RuntimeError;
use thiserror::Error;

#[derive(Debug, Error, Clone)]
#[error(transparent)]
pub struct LazyAssetError(#[from] pub(crate) Arc<anyhow::Error>);

impl LazyAssetError {
    pub fn new(err: impl Into<anyhow::Error>) -> Self {
        Self(Arc::new(err.into()))
    }
}

impl From<anyhow::Error> for LazyAssetError {
    fn from(e: anyhow::Error) -> Self {
        LazyAssetError(Arc::new(e))
    }
}

#[derive(Debug, Error)]
pub enum HauchiwaError {
    #[doc(hidden)]
    #[error(transparent)]
    AnyhowArc(Arc<anyhow::Error>),

    #[cfg(feature = "tokio")]
    #[error("Failed to build runtime")]
    RuntimeBuild(#[from] tokio::io::Error),

    #[error(transparent)]
    GlobPattern(#[from] glob::PatternError),

    #[error("Asset '{0}': {1}")]
    Asset(Box<str>, LazyAssetError),

    #[error("Loader '{0}': {1}")]
    Loader(String, LoaderError),

    #[error("Error while copying static content:\n{0}")]
    StepStatic(#[from] StepCopyStatic),

    #[error("Error while building the website.\n{0}")]
    Build(#[from] BuildError),

    #[cfg(feature = "live")]
    #[error("Error while watching for file changes:\n{0}")]
    Watch(#[from] WatchError),

    #[error("Asset '{0}' not found")]
    AssetNotFound(Box<str>),

    #[error("Preflight checks failed - missing:\n{0}")]
    Preflight(String),

    #[error("Cycle detected in task graph")]
    GraphCycle,
}

#[derive(Debug, Error)]
pub enum LoaderError {
    #[error("Couldn't load data from file.\n{0}")]
    FileSystem(#[from] std::io::Error),

    #[error("Couldn't compile glob pattern.\n{0}")]
    GlobPattern(#[from] glob::PatternError),

    #[error("Couldn't run glob.\n{0}")]
    Glob(#[from] glob::GlobError),

    #[error("Couldn't convert path to UTF-8.\n{0}")]
    PathFormat(#[from] camino::FromPathBufError),

    #[error("An error occured while loading asset.\n{0}")]
    Userland(#[from] anyhow::Error),
}

#[derive(Debug, Error)]
pub enum StepCopyStatic {
    #[error(transparent)]
    Io(#[from] std::io::Error),
    #[error("Static source path '{0}' does not exist")]
    MissingSource(String),
    #[error("Target path '{0}' is outside the allowed 'dist' directory")]
    UnsafeTarget(String),
}

#[derive(Debug, Error)]
pub enum BuildError {
    #[error(transparent)]
    Io(#[from] std::io::Error),

    #[error("Task '{0}':\n{1}")]
    Task(String, anyhow::Error),

    #[error("Hook:\n{0}")]
    Hook(anyhow::Error),

    #[error(transparent)]
    Other(anyhow::Error),
}

#[cfg(feature = "live")]
#[derive(Debug, Error)]
pub enum WatchError {
    #[error(transparent)]
    Io(#[from] std::io::Error),

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

    #[error(transparent)]
    Notify(#[from] notify::Error),

    #[error(transparent)]
    Recv(#[from] RecvError),

    #[error(transparent)]
    Send(#[from] SendError<()>),

    #[error(transparent)]
    Other(anyhow::Error),
}

#[derive(Debug, Error)]
pub enum ContextError {
    #[error(transparent)]
    Pattern(#[from] glob::PatternError),

    #[error("Asset not found: {0}")]
    NotFound(String),

    #[error("Asset not found: {0}, available assets with types {1}")]
    NotFoundWrongShape(String, String),

    #[error("Asset {0}:\n{1}")]
    LazyAssetError(String, LazyAssetError),
}