Struct HxResponseTrigger 

pub struct HxResponseTrigger {
    pub timing: TriggerTiming,
    pub events: Vec<HxEvent>,
}

Triggers client-side events via one of the HX-Trigger response headers.

When every event has no detail, the header is a comma-separated list of names. As soon as one event carries data, the whole header is serialized as a JSON object mapping each event name to its detail (or null).

Examples

use topcoat::htmx::{HxEvent, HxResponseTrigger};

// `HX-Trigger: refresh, close-modal`
let simple = HxResponseTrigger::receive(["refresh", "close-modal"]);

// JSON form, fired after the swap step.
let detailed =
    HxResponseTrigger::after_swap([HxEvent::with_data("show-toast", "Saved!").unwrap()]);

Fields

timing: TriggerTiming

When the events fire.

events: Vec<HxEvent>

The events to trigger.

Implementations

impl HxResponseTrigger

pub fn new( timing: TriggerTiming, events: impl IntoIterator<Item = impl Into<HxEvent>>, ) -> Self

Triggers events with the given timing.

pub fn receive(events: impl IntoIterator<Item = impl Into<HxEvent>>) -> Self

Triggers events as soon as the response is received (HX-Trigger).

pub fn after_settle( events: impl IntoIterator<Item = impl Into<HxEvent>>, ) -> Self

Triggers events after the settle step (HX-Trigger-After-Settle).

pub fn after_swap(events: impl IntoIterator<Item = impl Into<HxEvent>>) -> Self

Triggers events after the swap step (HX-Trigger-After-Swap).

Trait Implementations

impl Clone for HxResponseTrigger

fn clone(&self) -> HxResponseTrigger

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HxResponseTrigger

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

Formats the value using the given formatter.

impl Eq for HxResponseTrigger

impl IntoResponseParts for HxResponseTrigger

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 HxResponseTrigger

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HxResponseTrigger