Struct LiveContext 

pub struct LiveContext { /* private fields */ }

The request behind a live component’s action, and the effects it asks for (a toast, a redirect, events).

ctx.toast(Toast::success("Saved"));
ctx.dispatch("saved", json!({ "id": 3 }));
ctx.redirect("/done");

Implementations

impl LiveContext

pub fn state(&self) -> &AppState

The application state.

pub async fn mount<C: LiveComponent>(&self, c: C) -> Result<Mounted>

Renders component for a page: its state, its data and a signed snapshot. Pass the result to the page’s template and {% include "renox/live.html" %} it as component.

let mounted = ctx.mount(Counter { count: 0 }).await?;

pub fn session(&self) -> Option<&Session>

The request’s session, when there is one.

pub fn user(&self) -> Result<&AuthUser>

The signed-in user; Error::Unauthorized when nobody is.

pub fn toast(&mut self, toast: Toast)

Sends a toast with the answer.

pub fn redirect(&mut self, url: impl Into<String>)

Sends the browser to url (an HX-Redirect).

pub fn dispatch(&mut self, name: &str, detail: Value)

Fires the event rx:<component>:<name> on the component, with detail.

pub async fn validate(&self, value: &(impl Validate + Serialize)) -> Result

Checks value against its rules; a failure is a 422 with the field errors (and the input, for the form to show again).

ctx.validate(form).await?;

Trait Implementations

impl<S: Send + Sync> FromRequestParts<S> for LiveContext

type Rejection = Error

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts(parts: &mut Parts, state: &S) -> Result<Self>

Perform the extraction.