Struct RenderError 

pub struct RenderError { /* private fields */ }

Main error type for rendering operations: a non-empty collection of Diagnostics.

There is no failure taxonomy beyond the diagnostics themselves — the machine-routable identity of a failure is each diagnostic’s namespaced code (parse::*, validation::*, quill::*, typst::*, backend::*, engine::*). Every consumer, and every language binding, handles all rendering errors through this single shape; route on diagnostics()[..].code, not on a type.

Implementations

impl RenderError

pub fn new(diags: Vec<Diagnostic>) -> Self

Wrap diags as a failure. diags should be non-empty; the invariant is enforced only by debug_assert!, so a release build can construct an empty RenderError. That is deliberately non-fatal: the Display impl carries an [] fallback branch rather than promising the invariant is load-bearing. Every internal caller passes a non-empty vec.

pub fn from_diag(diag: Diagnostic) -> Self

Wrap a single diagnostic as a failure.

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

Returns all diagnostics for this error. Non-empty by construction (see RenderError::new’s debug-asserted invariant).

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

Consume the error and return its diagnostics.

pub fn summary_message(diags: &[Diagnostic]) -> String

The count-based summary line shared by Display and every binding’s exception message: the sole diagnostic’s message for one, an "<N> error(s): <first message>" aggregate for more. The single source of truth for this rule — bindings delegate here rather than re-deriving it. An empty slice yields "render error" defensively (see RenderError::new’s debug-only non-empty invariant).

Trait Implementations

impl Debug for RenderError

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

Formats the value using the given formatter.

impl Display for RenderError

The primary message for a single diagnostic; an "<N> error(s): <first message>" aggregate for more — the same rule the WASM binding applies to thrown Error.message.

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

fn from(err: ParseError) -> Self

Converts to this type from the input type.