Struct RenderCtx 

pub struct RenderCtx { /* private fields */ }

What a render takes beyond PageConfig: the policy’s typed extensions, the walk’s budgets, and the typed homes for what applications used to put in body_prefix: the route’s modulepreload links from the build’s manifest, and head links. Never a nonce: the render draws one per response. Data goes through PageConfig::config_json.

use forma_server::{HeadLink, PolicyExtensions, RenderCtx, WalkLimits};

let ctx = RenderCtx::new()
    .with_policy(PolicyExtensions::new().img_src("https:"))
    .with_limits(WalkLimits { max_list_iterations: 100_000, ..WalkLimits::default() })
    .with_head_link(HeadLink::new("icon", "/favicon.svg")?);

Implementations

impl RenderCtx

pub fn new() -> Self

The strict policy with limits inherited from the bound page.

pub fn with_title(self, title: impl Into<String>) -> Self

Override the bound page’s document title for this request; escaped as text.

pub fn with_body_class(self, class: impl Into<String>) -> Self

Set this request’s body class; escaped as an attribute.

pub fn with_config_json(self, value: Value) -> Self

Request data assigned to window.__FORMA_CONFIG__ by a nonced script. Static SSR routes refuse this executable configuration with RENDER-105.

pub fn with_personality_css(self, css: impl Into<String>) -> Self

Request branding CSS. The document writer neutralizes style end tags.

pub fn with_body_prefix(self, html: RawHtml) -> Self

Explicit trusted markup before the page root; plain strings do not satisfy this API.

pub fn with_policy(self, policy: PolicyExtensions) -> Self

Extend this page’s policy (see PolicyExtensions).

pub fn with_limits(self, limits: WalkLimits) -> Self

Override both walk budgets for this request only. Without this call, the handle’s bind-time limits apply. Use its limits() value with struct update syntax to change just one budget.

pub fn with_module_preloads(self, preloads: &ModulePreloads) -> Self

Write the route’s modulepreload links from the build’s manifest, each with the page’s nonce, after the route’s own modules. The typed home for a preload workaround in body_prefix, such as Ledger’s. The table covers every route; the render takes config.route_pattern’s list. Like every typed home, each call site belongs on the application’s raw-entry allowlist (forma-raw-lint).

use forma_server::{assets, ModulePreloads, RenderCtx};

// At start, beside the manifest; refuse to start on its error.
fn start<Assets: rust_embed::Embed>() -> Result<ModulePreloads, String> {
    assets::try_load_module_preloads::<Assets>()
}

// Per request.
fn ctx(preloads: &ModulePreloads) -> RenderCtx {
    RenderCtx::new().with_module_preloads(preloads)
}

Verified by: crates/forma-server/tests/internal_renderer/typed_homes.rs > “try_render_writes_the_routes_manifest_modulepreload_links_nonced”

pub fn with_head_link(self, link: HeadLink) -> Self

Add a <link> to the page’s head (see HeadLink), after any added before it. The typed home for links spliced in before </head>; each call site belongs on the application’s raw-entry allowlist (forma-raw-lint).

Verified by: crates/forma-server/tests/internal_renderer/typed_homes.rs > “head_links_are_written_escaped_in_the_head_in_the_order_added”

Trait Implementations

impl Clone for RenderCtx

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 RenderCtx

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

Formats the value using the given formatter.

impl Default for RenderCtx

fn default() -> Self

Returns the “default value” for a type.