Struct HxLocation 

pub struct HxLocation { /* private fields */ }

Builder for HX-Location header bodies.

HX-Location lets you instruct htmx to perform a navigation without a full page reload while still providing extra context (target selector, swap mode, request headers, etc.). Use Htmx::redirect_with_location to send the resulting header.

Implementations

impl HxLocation

pub fn new(path: impl Into<String>) -> Self

Create a new HX-Location builder pointing to the provided path.

pub fn target(self, selector: impl Into<String>) -> Self

Override which element receives the swap.

pub fn source(self, selector: impl Into<String>) -> Self

Set the selector for the element that should be treated as the source.

pub fn event(self, event: impl Into<String>) -> Self

Specify an event name to trigger on the client before navigation.

pub fn swap(self, swap: SwapType) -> Self

Change the swap behaviour for the follow-up request.

pub fn handler(self, handler: impl Into<String>) -> Self

Provide a custom client-side response handler.

pub fn select(self, selector: impl Into<String>) -> Self

Restrict the response fragment that htmx should swap.

pub fn header(self, name: impl Into<String>, value: impl Into<String>) -> Self

Add a custom header to the follow-up request.

pub fn headers<I, K, V>(self, headers: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Extend the custom headers with any iterator of key/value pairs.

pub fn values<T>(self, values: T) -> Result<Self>

where T: Serialize,

Serialize any value into the HX-Location values object.

pub fn disable_push(self) -> Self

Prevent htmx from pushing a new history entry.

pub fn push_path(self, path: impl Into<String>) -> Self

Override the history push path for the follow-up request.

pub fn replace(self, path: impl Into<String>) -> Self

Replace the browser history entry with the provided path.

Trait Implementations

impl Clone for HxLocation

fn clone(&self) -> HxLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HxLocation

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

Formats the value using the given formatter.

impl Serialize for HxLocation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.