Struct InertiaConfig

Source

pub struct InertiaConfig {
    pub app_name: String,
    pub vite_dev_server: String,
    pub entry_point: String,
    pub version: String,
    pub development: bool,
    pub html_template: Option<String>,
    pub manifest_path: String,
    pub title: Option<String>,
    pub head_extras: Option<String>,
    pub mount_id: String,
}

Expand description

Configuration for Inertia.js responses.

§Example

use ferro_inertia::InertiaConfig;

// Development configuration (default)
let config = InertiaConfig::default();

// Production configuration
let config = InertiaConfig::new()
    .version("1.0.0")
    .production();

// Custom Vite dev server
let config = InertiaConfig::new()
    .vite_dev_server("http://localhost:3000")
    .entry_point("src/app.tsx");

Fields§

§app_name: String

Application name used in the HTML title tag

§vite_dev_server: String

Vite dev server URL (e.g., “http://localhost:5173”)

§entry_point: String

Entry point for the frontend (e.g., “src/main.tsx”)

§version: String

Asset version for cache busting

§development: bool

Whether we’re in development mode (use Vite dev server)

§html_template: Option<String>

Custom HTML template (if None, uses default)

§manifest_path: String

Path to Vite’s manifest.json for resolving hashed asset filenames

§title: Option<String>

Optional page title. When Some, overrides app_name in <title>.

§head_extras: Option<String>

Raw HTML injected into <head> before </head> (meta, favicon, font tags). SECURITY: developer-controlled config only — never populate from request data. Ignored when html_template is set (the custom template owns <head>).

§mount_id: String

id attribute of the mount node. Defaults to "app".

Implementations§

Source §

impl InertiaConfig

Source

pub fn from_env() -> InertiaConfig

Build configuration from environment variables.

Reads APP_NAME, VITE_DEV_SERVER, VITE_ENTRY_POINT, INERTIA_VERSION, and APP_ENV. Mirrors the framework from_env() convention.

Source

pub fn new() -> InertiaConfig

Create a new configuration with default values.

Source

pub fn vite_dev_server(self, url: impl Into<String>) -> InertiaConfig

Set the Vite dev server URL.

Source

pub fn entry_point(self, entry: impl Into<String>) -> InertiaConfig

Set the frontend entry point.

Source

pub fn version(self, version: impl Into<String>) -> InertiaConfig

Set the asset version for cache busting.

Source

pub fn production(self) -> InertiaConfig

Enable production mode (disables Vite dev server integration).

Source

pub fn development(self) -> InertiaConfig

Enable development mode (enables Vite dev server integration).

Source

pub fn app_name(self, name: impl Into<String>) -> InertiaConfig

Set the application name used in the HTML title tag.

Source

pub fn manifest_path(self, path: impl Into<String>) -> InertiaConfig

Set the path to Vite’s manifest.json.

Source

pub fn html_template(self, template: impl Into<String>) -> InertiaConfig

Set a custom HTML template.

The template should contain the following placeholders:

{page} - The escaped JSON page data
{csrf} - The CSRF token (optional)

§Example

use ferro_inertia::InertiaConfig;

let template = r#"
<!DOCTYPE html>
<html>
<head><title>My App</title></head>
<body>
    <div id="app" data-page="{page}"></div>
    <script src="/app.js"></script>
</body>
</html>
"#;

let config = InertiaConfig::new()
    .html_template(template);

Source

pub fn title(self, t: impl Into<String>) -> InertiaConfig

Override the <title> tag. When None, falls back to app_name.

Source

pub fn head_extras(self, h: impl Into<String>) -> InertiaConfig

Raw HTML injected into <head> before </head>. Ignored when html_template is set.

Source

pub fn mount_id(self, id: impl Into<String>) -> InertiaConfig

Set the mount node id (default "app").

Trait Implementations§

Source §

impl Clone for InertiaConfig

Source §

fn clone(&self) -> InertiaConfig

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for InertiaConfig

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for InertiaConfig

Source §

fn default() -> InertiaConfig

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for InertiaConfig

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> Chain<T> for T

Source §

fn len(&self) -> usize

The number of items that this chain link consists of.

Source §

fn append_to(self, v: &mut Vec<T>)

Append the elements in this link to the chain.

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> Container<T> for T
where T: Clone,

Source §

type Iter = Once<T>

An iterator over the items within this container, by value.

Source §

fn get_iter(&self) -> <T as Container<T>>::Iter

Iterate over the elements of the container (using internal iteration because GATs are unstable).

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §