Struct InertiaConfig

pub struct InertiaConfig<T, V>
where
    T: 'static,
    V: ToString,
{
    pub url: &'static str,
    pub version: InertiaVersion<V>,
    pub template_path: &'static str,
    pub template_resolver: &'static (dyn Fn(&'static str, ViewData, &'static T) -> TemplateResolverOutput + Send + Sync + 'static),
    pub template_resolver_data: &'static T,
    pub with_ssr: bool,
    pub custom_ssr_client: Option<SsrClient>,
    pub view_data: Option<Map<String, Value>>,
    pub reflash_inertia_session: Box<dyn Fn(Option<InertiaTemporarySession>) -> Result<(), InertiaError> + Send + Sync>,
}

A configuration struct for initializing Inertia. You can directly fill the struct or use the builder fluent syntax by calling InertiaConfig::builder(), and finally InertiaConfig::build().

Note that, even with builder, most of fields are mandatory and trying to build without filling them will cause your application to panic!

• url - A valid href of the currentapplication
• version - The current asset version of the application. See Asset versioning for more details.
• template_path - The path for the root html template.
• template_resolver - A function that renders the given root template html. Check more details at Inertia::template_resolver document string.
• template_resolver_data - The third parameter of your template resolver. Inertia will pass it by reference when calling the resolver function. If you don’t plan to use it, just pass an empty tuple (both here and in your template resolver).
• with_ssr - Whether Server-side Rendering should be enabled.
• custom_ssr_client - An Option<SsrClient> with the Inertia Server address. If None is given, SsrClient::default will be used.
• view_data - Optional view data to be passed to the root template. It must be handled by the provided template_resolver.

Fields

url: &'static str

version: InertiaVersion<V>

template_path: &'static str

template_resolver: &'static (dyn Fn(&'static str, ViewData, &'static T) -> TemplateResolverOutput + Send + Sync + 'static)

template_resolver_data: &'static T

with_ssr: bool

custom_ssr_client: Option<SsrClient>

view_data: Option<Map<String, Value>>

reflash_inertia_session: Box<dyn Fn(Option<InertiaTemporarySession>) -> Result<(), InertiaError> + Send + Sync>

Implementations

impl<T, V> InertiaConfig<T, V>

where T: 'static, V: ToString,

pub fn builder() -> InertiaConfigBuilder<T, V>

Instatiates a new InertiaConfigBuilder instance. It must be configured using a fluent syntax.

Examples

use inertia_rust::{InertiaVersion, InertiaConfig};
let inertia_config = InertiaConfig::builder()
    .set_url("http://localhost:8080")
    .set_version(InertiaVersion::Literal("v1"))
    .set_template_path("path/to/template.html")
    .set_template_resolver(&your_template_resolver)
    .set_template_resolver_data(&())
    .build();