Struct HxEvent 

pub struct HxEvent {
    pub name: String,
    pub data: Option<Value>,
}

A client-side event for htmx to trigger, optionally carrying a JSON detail.

Fields

name: String

The event name.

data: Option<Value>

An optional detail payload delivered to the event listener.

Implementations

impl HxEvent

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

Creates an event that triggers with no detail.

pub fn with_data(name: impl Into<String>, data: impl Serialize) -> Result<Self>

Creates an event carrying data as its detail.

Errors

Returns an error if data cannot be serialized to JSON.

Trait Implementations

impl Clone for HxEvent

fn clone(&self) -> HxEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HxEvent

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

Formats the value using the given formatter.

impl Eq for HxEvent

impl From<&str> for HxEvent

fn from(name: &str) -> Self

Converts to this type from the input type.

impl From<String> for HxEvent

fn from(name: String) -> Self

Converts to this type from the input type.

impl PartialEq for HxEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HxEvent