Enum WebUIError 

pub enum WebUIError {
    ComponentAssetPublication {
        context: String,
        source: Box<dyn Error + Send + Sync>,
    },
    Io {
        context: String,
        source: Error,
    },
    ComponentRegistration {
        context: String,
        source: ParserError,
    },
    ComponentDiscovery(String),
    Parse {
        context: String,
        source: ParserError,
    },
    Protocol(ProtocolError),
    Serialization(String),
    Rendering(HandlerError),
    InvalidBuildOptions(String),
    ComponentAssets(Box<Diagnostic>),
    Projection(Box<Diagnostic>),
}

Errors that can occur during WebUI build, render, or inspection operations.

Variants

ComponentAssetPublication

Transactional component asset publication or cleanup failure.

Fields

context: String

The failed publication operation.

source: Box<dyn Error + Send + Sync>

The underlying filesystem, serialization, or finalization error.

Io

I/O error (file read/write failures).

Fields

context: String

What operation failed.

source: Error

The underlying I/O error.

ComponentRegistration

Component registration failure while reading, transforming, or inserting an authored component source.

context names what was being registered (an app directory or a discovered source). The underlying ParserError is preserved as a structured #[source] rather than being flattened to a string, so a build-time authoring mistake surfaced by a component-source transform reaches the CLI as ParserError::Template with its stable diagnostic code, source location, snippet, and help intact — the same structured path already used by WebUIError::Parse.

Fields

context: String

What was being registered (path or discovered source).

source: ParserError

The underlying registration error, structurally preserved.

ComponentDiscovery(String)

Component discovery failure (npm packages or local paths).

Parse

HTML/CSS parsing failure with context about which file failed.

Fields

context: String

What was being parsed.

source: ParserError

The underlying parse error.

Protocol(ProtocolError)

Protocol serialization or deserialization failure.

Serialization(String)

JSON serialization failure.

Rendering(HandlerError)

Handler rendering error.

InvalidBuildOptions(String)

Invalid build-option configuration.

ComponentAssets(Box<Diagnostic>)

Static component asset graph failure with a structured diagnostic.

Projection(Box<Diagnostic>)

Bundler-neutral state projection manifest failure: malformed schema, stale/missing input or output file, build-ID mismatch, conflicting or duplicate fragment ownership, missing scripted-component coverage, or an incompatible plugin. Carries a structured, color-free [Diagnostic] with a stable PROJ-* code (see webui::projection::codes).

The diagnostic is boxed so this cold error path does not enlarge Result<_, WebUIError> on the common success path.

Implementations

impl WebUIError

pub fn chain_message(&self) -> String

The full, single-line message including the source chain, e.g. Failed to parse index.html: Directive error: Invalid for each: x.

Each error layer’s std::fmt::Display describes only its own level (the #[source] chain carries the rest), so the CLI and dev server can use anyhow’s {:#} formatting without repetition. Hosts that surface a flat string instead of walking the chain — Node, FFI — use this helper to get the same complete message.

Trait Implementations

impl Debug for WebUIError

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

Formats the value using the given formatter.

impl Display for WebUIError

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

Formats the value using the given formatter.

impl Error for WebUIError

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<HandlerError> for WebUIError

fn from(source: HandlerError) -> Self

Converts to this type from the input type.

impl From<ProtocolError> for WebUIError

fn from(source: ProtocolError) -> Self

Converts to this type from the input type.