Struct InertiaPage

pub struct InertiaPage<'a> { /* private fields */ }

Response containing a valid Inertia Payload that will be used by the Inertia client to render the components.

Implementations

impl<'a> InertiaPage<'a>

pub fn new( component: Component, url: &'a str, version: Option<&'a str>, props: Map<String, Value>, merge_props: Option<Vec<&'a str>>, deferred_props: Option<HashMap<&'a str, Vec<&'a str>>>, clear_history: bool, encrypt_history: bool, ) -> Self

Instantiates an Inertia Page object to sent as http response, according to Inertia Protocol.

Arguments

• component - The name of the javascript page component (e.g. “/Me”).
• url - The Inertia instance’s url (the application URL). It can be a whole href or an absolute hostless path (“/me”).
• version - Current assets version. Used to assert assets are up-to-date. See Inertia’s assets versioning page for more details.
• props - A map of the page’s props.
• merge_props - A list containing the keys of the properties that shall me merged by the client-side adapter.
• deferred_props - A hashmap of which the keys are groups. It contains the keys of the props that must be fetched by the client-side adapter after the first page load. Refer to Deferred Props for more details.
• clear_history - Whether the history must be cleaned by the client-side once this response is received. Refer to Clearing history section from History Encryption documentatin for more details.
• encrypt_history - Whether the client-side adapter must encrypt the history page data related to this response. Refer to History Encryption for more details.

pub fn get_props(&self) -> &Map<String, Value>

pub fn get_component(&self) -> &Component

pub fn get_url(&self) -> &str

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

pub fn get_clear_history(&self) -> bool

pub fn get_encrypt_history(&self) -> bool

pub fn get_deferred_props(&self) -> &Option<HashMap<&'_ str, Vec<&'_ str>>>

pub fn get_merge_props(&self) -> &Option<Vec<&str>>

Trait Implementations

impl<'a> Clone for InertiaPage<'a>

fn clone(&self) -> InertiaPage<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for InertiaPage<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for InertiaPage<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq for InertiaPage<'a>

fn eq(&self, other: &InertiaPage<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for InertiaPage<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for InertiaPage<'a>

impl<'a> StructuralPartialEq for InertiaPage<'a>