Struct RuntimeLayer 

pub struct RuntimeLayer { /* private fields */ }

Available on crate feature router only.

A Layer that handles runtime requests at each page’s URL.

The browser can request a render in two ways:

• Send a POST with X-Topcoat-Runtime: true and the document’s signal values as JSON. The layer rewrites this to a GET at the same path and query. The page, layouts, and guards run with the supplied signal values. The rewritten request has an empty body and no RUNTIME_HEADER, Content-Type, or Content-Length headers. To read the original method, use original_method.
• Open a WebSocket with the RUNTIME_PROTOCOL subprotocol. Each render request on this connection describes an HTTP request: a method, a path, a body, and a few runtime headers, such as RUNTIME_HEADER for a page rerun. The layer dispatches it with the handshake’s other headers as a connected render. Renders run side by side, and each message sent back names the render it belongs to. A connection may have at most max_runs_per_connection renders at once.

WebSocket connections are supported on native servers. HTTP page reruns are also available on WebAssembly.

Other requests pass through unchanged, including form submissions and WebSocket requests that do not use the runtime subprotocol. The layer adds RuntimeSetup to their context.

Add it after your application’s pathless layers so they receive the rewritten GET.

use topcoat_router::Router;
use topcoat_runtime::RuntimeLayer;

let router = Router::builder().layer(RuntimeLayer::new()).build();

Implementations

impl RuntimeLayer

pub const fn new() -> Self

Creates a runtime layer that allows 64 renders at once on each connection.

pub const fn max_runs_per_connection(self, max: usize) -> Self

Limits the number of renders running at once on a runtime connection. The default limit is 64.

Each connected page or shard has a render, unless it is inside another connected page or shard. At the limit, new render requests receive 429 Too Many Requests. They can be accepted again once a render finishes or stops.

use topcoat_router::Router;
use topcoat_runtime::RuntimeLayer;

let router = Router::builder()
    .layer(RuntimeLayer::new().max_runs_per_connection(128))
    .build();

Trait Implementations

impl Clone for RuntimeLayer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RuntimeLayer

impl Debug for RuntimeLayer

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

Formats the value using the given formatter.

impl Default for RuntimeLayer

fn default() -> Self

Returns the “default value” for a type.

impl Layer for RuntimeLayer

fn path(&self) -> Option<&Path>

The URL path prefix whose matched routes this layer wraps, or None to wrap every request.

fn handle<'a>( &'a self, cx: &'a Cx, body: Body, next: Next<'a>, ) -> LayerFuture<'a>

Handles a request, calling next to continue down the chain.

fn context(&self) -> ContextMap

The values attached to this layer, such as defaults for the routes it wraps.