Skip to main content

Event

Enum Event 

Source
pub enum Event {
Show 32 variants Pointer(PointerEvent), PointerCancel(PointerCancelEvent), Timer { token: TimerToken, }, Ime(ImeEvent), ExternalDrag(ExternalDragEvent), ExternalDropData(ExternalDropDataEvent), InternalDrag(InternalDragEvent), KeyDown { key: KeyCode, modifiers: Modifiers, repeat: bool, }, KeyUp { key: KeyCode, modifiers: Modifiers, }, TextInput(String), SetTextSelection { anchor: u32, focus: u32, }, ClipboardWriteCompleted { token: ClipboardToken, outcome: ClipboardWriteOutcome, }, ClipboardReadText { token: ClipboardToken, text: String, }, ClipboardReadFailed { token: ClipboardToken, error: ClipboardAccessError, }, ShareSheetCompleted { token: ShareSheetToken, outcome: ShareSheetOutcome, }, PrimarySelectionText { token: ClipboardToken, text: String, }, PrimarySelectionTextUnavailable { token: ClipboardToken, }, FileDialogSelection(FileDialogSelection), FileDialogData(FileDialogDataEvent), FileDialogCanceled, IncomingOpenRequest { token: IncomingOpenToken, items: Vec<IncomingOpenItem>, }, IncomingOpenData(IncomingOpenDataEvent), IncomingOpenUnavailable { token: IncomingOpenToken, }, ImageRegistered { token: ImageUploadToken, image: ImageId, width: u32, height: u32, }, ImageRegisterFailed { token: ImageUploadToken, message: String, }, ImageUpdateApplied { token: ImageUpdateToken, image: ImageId, }, ImageUpdateDropped { token: ImageUpdateToken, image: ImageId, reason: ImageUpdateDropReason, }, WindowCloseRequested, WindowFocusChanged(bool), WindowScaleFactorChanged(f32), WindowMoved(WindowLogicalPosition), WindowResized { width: Px, height: Px, },
}

Variants§

§

Pointer(PointerEvent)

§

PointerCancel(PointerCancelEvent)

§

Timer

Fields

§

Ime(ImeEvent)

§

ExternalDrag(ExternalDragEvent)

§

ExternalDropData(ExternalDropDataEvent)

§

InternalDrag(InternalDragEvent)

§

KeyDown

Fields

§modifiers: Modifiers
§repeat: bool
§

KeyUp

Fields

§modifiers: Modifiers
§

TextInput(String)

§

SetTextSelection

Sets the current selection (or caret when anchor == focus) in UTF-8 byte offsets within the focused widget’s text buffer (ADR 0071).

This event is primarily intended for accessibility and automation backends.

Fields

§anchor: u32
§focus: u32
§

ClipboardWriteCompleted

Clipboard write request completed.

§

ClipboardReadText

Clipboard text payload delivered to the focused widget (typically as the result of a paste request).

Fields

§text: String
§

ClipboardReadFailed

Clipboard read completed without a text payload (clipboard empty/unavailable/error).

§

ShareSheetCompleted

Share sheet request completed.

§

PrimarySelectionText

Linux primary selection text payload delivered to the focused widget.

This typically originates from middle-click paste when primary selection is enabled.

Fields

§text: String
§

PrimarySelectionTextUnavailable

Primary selection read completed without a text payload (unavailable/empty/error).

Fields

§

FileDialogSelection(FileDialogSelection)

File dialog selection metadata (token + names). Bytes must be requested via effects.

§

FileDialogData(FileDialogDataEvent)

File dialog data payload, typically produced by Effect::FileDialogReadAll.

§

FileDialogCanceled

A file dialog request completed without a selection (user canceled).

§

IncomingOpenRequest

Incoming-open request originating from the OS (open-in / share-target).

Apps must treat the token as ephemeral; privileged platform references remain runner-owned.

§

IncomingOpenData(IncomingOpenDataEvent)

Incoming-open data payload, typically produced by Effect::IncomingOpenReadAll.

§

IncomingOpenUnavailable

Incoming-open token became unavailable (denied/revoked/expired).

Fields

§

ImageRegistered

Image resource registration completed and produced an ImageId.

Fields

§image: ImageId
§width: u32
§height: u32
§

ImageRegisterFailed

Image resource registration failed (e.g. invalid bytes, backend error).

Fields

§message: String
§

ImageUpdateApplied

Optional acknowledgement that a streaming image update was applied.

This is intended for debugging/telemetry surfaces and must be capability-gated by the runner to avoid flooding the event loop during video playback (ADR 0124).

Fields

§image: ImageId
§

ImageUpdateDropped

Optional acknowledgement that a streaming image update was dropped.

See ImageUpdateApplied for rationale (ADR 0124).

§

WindowCloseRequested

Window close button / OS close request was triggered.

The runner must not close the window immediately; the app/driver may intercept the request (e.g. unsaved-changes confirmation) and decide whether to emit WindowRequest::Close.

§

WindowFocusChanged(bool)

Window focus state changed (focused vs blurred).

§

WindowScaleFactorChanged(f32)

§

WindowMoved(WindowLogicalPosition)

§

WindowResized

Fields

§width: Px
§height: Px

Trait Implementations§

Source§

impl Clone for Event

Source§

fn clone(&self) -> Event

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Event

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Event

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for Event

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

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.