Enum RenderError 

#[non_exhaustive]
pub enum RenderError {
    #[non_exhaustive]
    StaticRoute {
        route: String,
        message: String,
    },
    #[non_exhaustive]
    Manifest {
        route: String,
        message: String,
    },
    #[non_exhaustive]
    RouteMode {
        route: String,
    },
    #[non_exhaustive]
    Unfinalized {
        route: String,
    },
    #[non_exhaustive]
    Props {
        cause: PropsError,
    },
    #[non_exhaustive]
    Binding {
        route: String,
        errors: Vec<PropsError>,
    },
    #[non_exhaustive]
    MissingModule {
        route: String,
    },
    #[non_exhaustive]
    Walk {
        route: String,
        component_path: Vec<String>,
        counts: RenderCounts,
        cause: IrError,
    },
    #[non_exhaustive]
    IslandState {
        route: String,
        component_path: Vec<String>,
        counts: RenderCounts,
        cause: IrError,
    },
    #[non_exhaustive]
    Policy {
        route: String,
        cause: PolicyError,
    },
    #[non_exhaustive]
    Nonce {
        route: String,
        cause: NonceError,
    },
    #[non_exhaustive]
    Budget {
        route: String,
        component_path: Vec<String>,
        counts: RenderCounts,
        cause: IrError,
    },
    #[non_exhaustive]
    Fault {
        route: String,
        component_path: Vec<String>,
        counts: RenderCounts,
        message: String,
    },
}

Why a page was not rendered. Nothing reaches the browser unless the handler sends it: answer with the application’s own error page.

Every error has a stable code, the route it was rendering, and the component_path where it stopped (empty when the failure is not inside a component). The codes, by family:

Code	Variant	Cause
RENDER-101	MissingModule	The config has no module or no slots to render
RENDER-104	Manifest	Invalid manifest or referenced integrity
RENDER-105	StaticRoute	A static SSR route requires JavaScript for islands, configuration or preloads
RENDER-103	RouteMode	A shell route is absent or not Browser
RENDER-406	Unfinalized	Required startup finalization is incomplete
RENDER-102	Walk	The walk refused the module or its data
RENDER-503	Walk	A keyed list row has no usable identity, repeats another row’s key, or has no single root to carry it (FORMA-181)
RENDER-201	Policy	A policy extension is not a source a page may add
RENDER-202	Nonce	The system random source failed to draw a nonce
RENDER-301	Budget	The complete escaped response passed max_output_bytes
RENDER-302	Budget	The walk’s list rows passed max_list_iterations
RENDER-303	Budget	Lists or control flow nested past the walker’s depth
RENDER-501	IslandState	Declared island input mapping or value is invalid
RENDER-502	IslandState	Escaped island state exceeds one MiB
RENDER-399	Fault	The render panicked; a defect, not an input

A code, once published, keeps its meaning; new causes get new codes.

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.

#[non_exhaustive]

StaticRoute

RENDER-105: a static SSR route cannot execute or preload JavaScript.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

The requested route.

message: String

The incompatible island, configuration or preload contract.

#[non_exhaustive]

Manifest

RENDER-104: manifest or referenced resource integrity is invalid.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

The requested route.

message: String

Manifest validation failure or the resource whose integrity is unavailable.

#[non_exhaustive]

RouteMode

RENDER-103: a browser shell requires an explicitly declared browser route.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

The requested route.

#[non_exhaustive]

Unfinalized

RENDER-406: every SSR handler must bind and the registry must finalize first.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

The bound route.

#[non_exhaustive]

Props

RENDER-401..404: a handler value violates its declared contract.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

cause: PropsError

Checked value error, including its declared property path and sources.

#[non_exhaustive]

Binding

RENDER-405: a development reload no longer matches the bound handler.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

Bound route.

errors: Vec<PropsError>

Binding refusals for the changed module. No partial HTML is returned.

#[non_exhaustive]

MissingModule

RENDER-101: Server rendering, and the config carries no module or no slots for it. A browser-rendered route is served by render_browser_shell, by declaration.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

The route being rendered.

#[non_exhaustive]

Walk

RENDER-102: the walk refused the module or the data it was given.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

The route being rendered.

component_path: Vec<String>

The islands open where the walk stopped, outermost first.

counts: RenderCounts

How far the walk got.

cause: IrError

The walker’s error.

#[non_exhaustive]

IslandState

RENDER-501 or RENDER-502: no partial state or page is returned.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

Route whose island state was refused.

component_path: Vec<String>

Open island registration names, outermost first.

counts: RenderCounts

Body walk work completed before refusal.

cause: IrError

The invalid field path or fixed state-byte ceiling.

#[non_exhaustive]

Policy

RENDER-201: a policy extension was refused; there is no page to send without its policy.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

The route being rendered.

cause: PolicyError

The refused extension.

#[non_exhaustive]

Nonce

RENDER-202: no nonce could be drawn, so no policy could bless the page.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

The route being rendered.

cause: NonceError

The failed draw.

#[non_exhaustive]

Budget

RENDER-301, RENDER-302, RENDER-303: the complete response exceeded its output-byte limit, or the walk reached a list/depth budget.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

The route being rendered.

component_path: Vec<String>

The islands open where the walk stopped, outermost first.

counts: RenderCounts

Body-only walk work, including when complete response assembly refuses.

cause: IrError

The output, list, or depth budget that refused the response.

#[non_exhaustive]

Fault

RENDER-399: the render panicked and the panic was caught. The process and every other request carry on, while the application unwinds on panic; under panic = "abort" the process ends.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

route: String

The route being rendered.

component_path: Vec<String>

The islands open where the walk panicked, when it was in the walk.

counts: RenderCounts

How far the walk got, when it was in the walk.

message: String

The panic’s message.

Implementations

impl RenderError

pub fn code(&self) -> &'static str

The stable code, such as RENDER-301.

pub fn route(&self) -> &str

The route pattern the render was for.

pub fn property_path(&self) -> Option<&str>

The declared property path of a checked-value refusal.

pub fn component_path(&self) -> &[String]

The component names of the islands open where the render stopped, outermost first; empty when it stopped outside every island or before the walk. A component the compiler inlined into its parent has no name until FMIR v3’s source positions.

pub fn counts(&self) -> Option<RenderCounts>

How far the walk got, for an error raised during it.

Trait Implementations

impl Clone for RenderError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RenderError