Enum SsgError 

#[non_exhaustive]
pub enum SsgError {
    InvalidPath {
        path: String,
        reason: &'static str,
    },
    UnsafeCleanTarget {
        path: PathBuf,
        reason: &'static str,
    },
    Io {
        path: PathBuf,
        source: Error,
    },
    Pages(Vec<(String, SsgError)>),
}

Available on crate feature ssg only.

Why a static site operation failed.

A real error type rather than io::Error::other(String), so a caller can tell an unsafe path from a full disk and can read which page of a bulk build failed. It converts into io::Error (? works in a function returning io::Result), keeping InvalidInput for the two refusals.

Examples

use molt::ssg::{SsgError, StaticSiteGenerator};

let site = StaticSiteGenerator::new("dist");
let error = site.write_file("x", "../escape.html").expect_err("refused");
assert!(matches!(error, SsgError::InvalidPath { .. }));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidPath

A page or asset path that cannot be written under the output directory: a .., a root or drive prefix, no file name, or a symbolic link on the way.

Fields

path: String

The path as given.

reason: &'static str

What is wrong with it.

UnsafeCleanTarget

clean refused to delete the output directory.

Fields

path: PathBuf

The directory as given.

reason: &'static str

Why it is too dangerous to remove.

Io

The filesystem failed.

Fields

path: PathBuf

The file or directory the operation was working on.

source: Error

The underlying error.

Pages(Vec<(String, SsgError)>)

Several pages of a bulk build failed. Every failure is here, not just the first.

Trait Implementations

impl Debug for SsgError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for SsgError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for SsgError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<SsgError> for Error

fn from(error: SsgError) -> Self

Converts to this type from the input type.