Enum OutEvent 

#[non_exhaustive]
pub enum OutEvent {
    Action {
        name: String,
        component_id: String,
        event: String,
        context: Value,
        payload: Option<Value>,
    },
    OpenUrl {
        url: String,
    },
    FunctionCall {
        component_id: String,
        name: String,
        args: Value,
    },
    DataChanged {
        path: String,
        value: Value,
    },
    Input {
        component_id: String,
        name: String,
        path: Option<String>,
        value: Value,
        commit: bool,
    },
    Focus {
        id: String,
        index: u32,
    },
    Announce {
        text: String,
        live: String,
    },
    Copy {
        text: String,
    },
    PickFiles {
        component_id: String,
        accept: Option<String>,
        multiple: bool,
    },
    Relayout,
    HoverTimer {
        owner: String,
        delay_ms: u32,
    },
    ScrollSurface {
        x: f32,
        y: f32,
    },
}

What the host must do after an interaction (non_exhaustive: match with a wildcard arm; new kinds are additive). The wire form is camelCase throughout, kinds AND fields ({kind: "action", componentId, …}, {kind: "hoverTimer", owner, delayMs}), as the host API’s.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Action

A server event (A2UI action): forward it. context = the author’s context with the event payload merged over it.

Fields

name: String

component_id: String

event: String

context: Value

payload: Option<Value>

OpenUrl

openUrl or a Link.

Fields

url: String

FunctionCall

An on.<event> functionCall naming a HOST function (not one of the catalog’s built-ins, FUNCTION_NAMES): the host looks it up in its registry and runs it through the policy gate (host::decide_function, VAPP-91). args = the call’s args resolved against the data model and scope. Serialized {kind: "functionCall", componentId, name, args}.

Fields

component_id: String

name: String

args: Value

DataChanged

A bound value was written through to the data model.

Fields

path: String

value: Value

Input

A host-owned input edit (the host forwards with its revision).

Fields

component_id: String

name: String

path: Option<String>

value: Value

commit: bool

Focus

Move keyboard focus (a Form’s first invalid field, focus command).

Fields

id: String

index: u32

Announce

Speak through the platform’s live region.

Fields

text: String

live: String

Copy

Put text on the clipboard (CodeBlock copy).

Fields

text: String

PickFiles

Open the platform file picker for a FileUpload; the picked files come back as event(<dropzone>, "upload", {files}) (bytes via the host).

Fields

component_id: String

accept: Option<String>

multiple: bool

Relayout

Local UI state changed: lay out again.

HoverTimer

Call Surface::hover_timeout(owner) after delay_ms (a hover overlay whose trigger and content were left; it closes then unless the pointer came back). Keep ONE timer per owner: a new HoverTimer for the same owner restarts it.

Fields

owner: String

delay_ms: u32

ScrollSurface

Round 2: scroll the host viewport of the whole surface to (x, y) (a scrollToIndex on a list the page scrolls), then report it with Surface::set_surface_scroll.

Fields

x: f32

y: f32

Trait Implementations

impl Clone for OutEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OutEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OutEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OutEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OutEvent