Struct Inertia

pub struct Inertia { /* private fields */ }

The entrypoint to Inertia that is used by route handlers and response mapping middleware.

Implementations

impl Inertia

pub fn builder() -> InertiaBuilder

Create an instance of Inertia using the builder syntax

impl Inertia

pub fn render( self, component: &'static str, ) -> PropChain<impl Future<Output = Response>>

Render the current page with whatever props you have set.

NOTE: this will not immediately render as you may have some share middleware that will still be able to morph the response structure.

pub fn share(self, res: Response) -> PropChain<impl Future<Output = Response>>

Produce a response that shares all of your props.

pub fn back(self) -> PropChain<FlashedResponse>

Redirects you and returns you back to the referrer. Any props set automatically will become flashed.

pub fn set_version(&self, version: &'static str)

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

Provides the current version, used for defining cache busting in your versioning provider

pub fn set_html_sandwich(&self, head: String, tail: String)

pub fn set_flash_props_for_next_request(&self, cb: impl FnOnce(Value))

Set flash props on the request / response for the next request

pub fn apply_flash_props(&self, flash_props: Value)

Apply flash props to the current request

pub fn next_response(self, res: Response) -> Response

When using response middleware to modify the response, you must use this so that the correct continuation data goes through to allow inertia to work

Trait Implementations

impl<S> FromRequestParts<S> for Inertia

where S: Send + Sync,

type Rejection = Infallible

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, Self::Rejection>

Perform the extraction.