Struct HxResponseTrigger 

pub struct HxResponseTrigger {
    pub mode: TriggerMode,
    pub events: Vec<HxEvent>,
}

The HX-Trigger* header.

Allows you to trigger client-side events. Corresponds to HX-Trigger, HX-Trigger-After-Settle and HX-Trigger-After-Swap headers. To change when events trigger use appropriate mode.

Will fail if the supplied events contain or produce characters that are not visible ASCII (32-127) when serializing to JSON.

See https://htmx.org/headers/hx-trigger/ for more information.

Note: An HxResponseTrigger implements IntoResponseParts and should be used before any other response object would consume the response parts.

Fields

mode: TriggerMode

events: Vec<HxEvent>

Implementations

impl HxResponseTrigger

pub fn new<T: Into<HxEvent>>( mode: TriggerMode, events: impl IntoIterator<Item = T>, ) -> Self

Creates new trigger with specified mode and events.

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

Creates new normal trigger from events.

See HxResponseTrigger for more information.

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

Creates new after settle trigger from events.

See HxResponseTrigger for more information.

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

Creates new after swap trigger from events.

See HxResponseTrigger for more information.

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<T> From<(TriggerMode, T)> for HxResponseTrigger

where T: IntoIterator, T::Item: Into<HxEvent>,

fn from((mode, events): (TriggerMode, T)) -> Self

Converts to this type from the input type.

impl IntoResponseParts for HxResponseTrigger

type Error = HxError

The type returned in the event of an error.

fn into_response_parts( self, res: ResponseParts, ) -> Result<ResponseParts, Self::Error>

Set parts of the response