Skip to main content

Dispatch

Enum Dispatch 

Source
pub enum Dispatch {
    Effect {
        request_id: String,
        kind: String,
        payload: Value,
    },
    WidgetOp {
        op: String,
        payload: Value,
    },
    Window(WindowOp),
    WindowQuery(WindowQuery),
    System(SystemOp),
    SystemQuery(SystemQuery),
    Image {
        op: String,
        handle: String,
        data: Option<Vec<u8>>,
        pixels: Option<Vec<u8>>,
        width: Option<u32>,
        height: Option<u32>,
    },
}
Expand description

Platform or widget operations the host must execute on Core’s behalf. Core doesn’t touch iced, stdout, or the filesystem; it produces these typed commands and the host dispatches them.

Variants§

§

Effect

Handle a platform effect (file dialog, clipboard, notification).

Core does not execute effects; it passes the raw request through for the host to dispatch. The host decides whether to run the effect synchronously, asynchronously (via Task::perform), or return unsupported (e.g. in headless mode where file dialogs are unavailable).

§Known effect kinds

Async (file dialogs): file_open, file_open_multiple, file_save, directory_select, directory_select_multiple

Sync (clipboard): clipboard_read, clipboard_write, clipboard_read_html, clipboard_write_html, clipboard_clear, clipboard_read_primary, clipboard_write_primary

Sync (notification): notification

Fields

§request_id: String
§kind: String
§payload: Value
§

WidgetOp

Renderer-internal widget-targeted operation by op string.

Covers focus, scroll, cursor, pane-grid ops, tree_hash queries, list_images, load_font, announce, exit, find_focused.

Fields

§payload: Value
§

Window(WindowOp)

Typed window operation (open, close, resize, move, …).

§

WindowQuery(WindowQuery)

Typed window query (get_size, get_position, …).

§

System(SystemOp)

Typed system-wide operation.

§

SystemQuery(SystemQuery)

Typed system-wide query.

§

Image

Image registry operation that targets a specific handle.

§Known ops

create_image, update_image, delete_image. Registry-level ops without per-image fields (list, clear) re-emit as WidgetOp and share the existing handlers.

Fields

§handle: String
§data: Option<Vec<u8>>
§pixels: Option<Vec<u8>>
§width: Option<u32>
§height: Option<u32>

Trait Implementations§

Source§

impl Debug for Dispatch

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<State, Message> IntoBoot<State, Message> for State

Source§

fn into_boot(self) -> (State, Task<Message>)

Turns some type into the initial state of some Application.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> MaybeClone for T

Source§

impl<T> MaybeDebug for T

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,