Struct HxLocation 

pub struct HxLocation {
    pub path: String,
    pub options: LocationOptions,
}

Performs a client-side redirect that does not trigger a full page reload, via the HX-Location header.

In its simplest form it carries just a path. Set any of the LocationOptions fields, through the builder methods, to control how htmx fetches and swaps the new content; when any option is set, the header is serialized as JSON.

Examples

use topcoat::htmx::{HxLocation, SwapOption};

// Plain path: `HX-Location: /home`
let simple = HxLocation::new("/home");

// With options, serialized as JSON.
let detailed = HxLocation::new("/home")
    .target("#main")
    .swap(SwapOption::InnerHtml);

Fields

path: String

The path (URL) to fetch the new content from.

options: LocationOptions

Optional context controlling the fetch and swap.

Implementations

impl HxLocation

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

Creates a location targeting path with no extra options.

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

Sets the source element for the request (source).

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

Sets the event that triggered the request (event).

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

Sets a callback that handles the response (handler).

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

Sets the element to swap the response into (target), a CSS selector.

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

Sets how the response is swapped in (swap).

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

Sets a CSS selector choosing which part of the response is used (select).

pub fn values(self, values: Value) -> Self

Sets values to submit with the request (values).

pub fn headers(self, headers: Value) -> Self

Sets headers to submit with the request (headers).

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 Eq for HxLocation

impl From<&str> for HxLocation

fn from(path: &str) -> Self

Converts to this type from the input type.

impl From<String> for HxLocation

fn from(path: String) -> Self

Converts to this type from the input type.

impl IntoResponseParts for HxLocation

fn into_response_parts(self, _cx: &Cx, parts: &mut Parts) -> Result<()>

Applies self to the response parts, using the request Cx for any request-scoped data.

impl PartialEq for HxLocation

fn eq(&self, other: &HxLocation) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HxLocation