Enum DocError 

#[non_exhaustive]
pub enum DocError {
    Frontmatter(String),
    Markdown(String),
    Template(Error),
    Io(Error),
    Escape(String),
}

Errors that can occur while building a Markdown → HTML site.

This error type is non-exhaustive and may gain new variants in future releases.

Variants

• Frontmatter: the ----delimited frontmatter block is malformed.
• Markdown: Markdown rendering failed.
• Template: Tera template loading or rendering failed.
• Io: an I/O error occurred (file read, write, or directory walk).
• Escape: a resolved output path would have written outside output_dir.

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.

Frontmatter(String)

Malformed frontmatter block.

Markdown(String)

Markdown render failure.

Template(Error)

Tera template load/render failure.

Io(Error)

I/O error from the filesystem.

Escape(String)

Output path resolved outside output_dir.

Implementations

impl DocError

pub fn user_message(&self) -> String

Returns a user-safe error message, never leaking filesystem or template internals.

Trait Implementations

impl Debug for DocError

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

Formats the value using the given formatter.

impl Display for DocError

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

Formats the value using the given formatter.

impl Error for DocError

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<Error> for DocError

fn from(e: Error) -> Self

Converts to this type from the input type.