Struct Event 

pub struct Event {
    pub name: String,
    pub target: Option<String>,
    pub value: Value,
    pub metadata: Map<String, Value>,
}

A normalized browser event delivered to a LiveView.

Examples

use shelly::Event;

let mut event = Event::new("save_profile");
event.target = Some("profile-form".to_string());

assert_eq!(event.name, "save_profile");
assert_eq!(event.target.as_deref(), Some("profile-form"));

Fields

name: String

Logical event name, for example inc, save_profile, or validate.

target: Option<String>

Optional DOM target id or client-provided target scope.

value: Value

Event value. For forms, this is usually an object built from FormData.

metadata: Map<String, Value>

Non-authoritative browser metadata.

Treat this data as untrusted. Use it for diagnostics or UX hints, not authorization.

Implementations

impl Event

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

Create a simple event with null value and no metadata.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Event

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Event

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<ClientMessage> for Event

type Error = ShellyError

The type returned in the event of a conversion error.

fn try_from(message: ClientMessage) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Event