Skip to main content

EventResult

Enum EventResult 

Source
pub enum EventResult {
    Action {
        event_name: String,
        context: HashMap<String, Value>,
        want_response: bool,
        response_path: Option<String>,
    },
    DataUpdate {
        path: String,
        value: Value,
    },
    Toggle {
        path: String,
    },
    Consumed,
}
Expand description

Result produced by a component handling an input event.

Variants§

§

Action

Dispatch an action to the server.

Fields

§event_name: String

The event name.

§context: HashMap<String, Value>

Context values to send with the event.

§want_response: bool

Whether the action expects a response.

§response_path: Option<String>

Optional data model path to write the response value.

§

DataUpdate

Write a value back to the data model at the given path.

Fields

§path: String

JSON Pointer path in the data model.

§value: Value

The new value.

§

Toggle

Toggle a boolean value in the data model.

Fields

§path: String

JSON Pointer path in the data model.

§

Consumed

Component consumed the event; no further processing needed.

Trait Implementations§

Source§

impl Clone for EventResult

Source§

fn clone(&self) -> EventResult

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EventResult

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.