Enum RenderError 

pub enum RenderError {
    EngineCreation {
        diags: Vec<Diagnostic>,
    },
    InvalidFrontmatter {
        diags: Vec<Diagnostic>,
    },
    CompilationFailed {
        diags: Vec<Diagnostic>,
    },
    FormatNotSupported {
        diags: Vec<Diagnostic>,
    },
    UnsupportedBackend {
        diags: Vec<Diagnostic>,
    },
    ValidationFailed {
        diags: Vec<Diagnostic>,
    },
    QuillConfig {
        diags: Vec<Diagnostic>,
    },
}

Main error type for rendering operations.

Every variant carries a non-empty diags: Vec<Diagnostic>. Variants whose failure is inherently a single diagnostic still carry a one-element vector — the uniform shape lets every consumer, and every language binding, handle all rendering errors through a single code path. See RenderError::diagnostics and RenderError::into_diagnostics. The variant itself records the kind of failure (which bindings map to typed exceptions); the payload is always just the diagnostics.

Variants

EngineCreation

Failed to create rendering engine.

Fields

diags: Vec<Diagnostic>

Diagnostics describing the failure. Always non-empty.

InvalidFrontmatter

Invalid YAML frontmatter in markdown document.

Fields

diags: Vec<Diagnostic>

Diagnostics describing the failure. Always non-empty.

CompilationFailed

Backend compilation failed with one or more errors.

Fields

diags: Vec<Diagnostic>

All compilation diagnostics. Always non-empty.

FormatNotSupported

Requested output format not supported by backend.

Fields

diags: Vec<Diagnostic>

Diagnostics describing the failure. Always non-empty.

UnsupportedBackend

Backend not registered with engine.

Fields

diags: Vec<Diagnostic>

Diagnostics describing the failure. Always non-empty.

ValidationFailed

Validation failed for parsed document — may carry multiple diagnostics when several problems are detected during a single validation pass (e.g. multiple missing required fields). Each diagnostic should set path to anchor the error at a specific location in the document model.

Fields

diags: Vec<Diagnostic>

All validation diagnostics. Always non-empty.

QuillConfig

Quill configuration error — may carry multiple diagnostics when several problems are detected during parsing (e.g. several unknown keys at once).

Fields

diags: Vec<Diagnostic>

All configuration diagnostics. Always non-empty.

Implementations

impl RenderError

pub fn diagnostics(&self) -> &[Diagnostic]

All diagnostics carried by this error, in order. Always non-empty.

pub fn into_diagnostics(self) -> Vec<Diagnostic>

Consume the error and return its diagnostics. Always non-empty.

Trait Implementations

impl Debug for RenderError

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

Formats the value using the given formatter.

impl Display for RenderError

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

Formats the value using the given formatter.

impl Error for RenderError

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<ParseError> for RenderError

Convert ParseError to RenderError

fn from(err: ParseError) -> Self

Converts to this type from the input type.