Skip to main content

CommandSender

Struct CommandSender 

Source
pub struct CommandSender { /* private fields */ }
Expand description

Cloneable, thread-safe producer for application commands.

Enqueueing a command wakes the platform loop. wake only schedules the runtime; it never synthesizes a widget event.

Implementations§

Source§

impl CommandSender

Source

pub fn wake(&self)

Source

pub fn send<T>(&self, target: CommandTarget, key: CommandKey<T>, payload: T)
where T: Send + Sync + 'static,

Source

pub fn broadcast<T>( &self, target: CommandTarget, key: CommandKey<T>, payload: T, )
where T: Send + Sync + 'static,

Source

pub fn send_widget<T>( &self, window_id: WindowId, widget_id: WidgetId, key: CommandKey<T>, payload: T, )
where T: Send + Sync + 'static,

Source

pub fn send_focused<T>( &self, window_id: WindowId, key: CommandKey<T>, payload: T, )
where T: Send + Sync + 'static,

Source

pub fn send_window<T>( &self, window_id: WindowId, key: CommandKey<T>, payload: T, )
where T: Send + Sync + 'static,

Source

pub fn send_application<T>(&self, key: CommandKey<T>, payload: T)
where T: Send + Sync + 'static,

Source

pub fn broadcast_window<T>( &self, window_id: WindowId, key: CommandKey<T>, payload: T, )
where T: Send + Sync + 'static,

Source

pub fn broadcast_application<T>(&self, key: CommandKey<T>, payload: T)
where T: Send + Sync + 'static,

Examples found in repository?
examples/commands.rs (lines 34-37)
6fn main() -> Result<()> {
7    let worker_status = Signal::named(
8        "worker_status",
9        "Waiting for the background worker…".to_string(),
10    );
11    let application_status = Signal::named(
12        "application_status",
13        "No application multicast received yet.".to_string(),
14    );
15    let window_status = Signal::named(
16        "window_status",
17        "No window multicast received yet.".to_string(),
18    );
19
20    let worker_handler = worker_status.clone();
21    let application_handler = application_status.clone();
22    let window_handler = window_status.clone();
23    let root = Padding::all(
24        24.0,
25        Stack::vertical()
26            .spacing(12.0)
27            .alignment(Alignment::Stretch)
28            .with_child(Label::new("Typed commands"))
29            .with_child(Label::new("").text_from(worker_status))
30            .with_child(Label::new("").text_from(application_status))
31            .with_child(Label::new("").text_from(window_status))
32            .with_child(
33                Button::new("Broadcast announcement").on_press_with_ctx(|ctx| {
34                    ctx.command_sender().broadcast_application(
35                        ANNOUNCEMENT,
36                        "Hello from a widget callback".to_string(),
37                    );
38                }),
39            ),
40    );
41
42    App::new()
43        .on_command(WORK_FINISHED, move |ctx, message| {
44            worker_handler.set(format!("Worker result: {message}"));
45            ctx.set_handled();
46        })
47        .on_command(ANNOUNCEMENT, move |_, message| {
48            application_handler.set(format!("Application received: {message}"));
49        })
50        .window(
51            Window::new("Commands")
52                .on_command(ANNOUNCEMENT, move |_, message| {
53                    window_handler.set(format!("Window received: {message}"));
54                })
55                .root(root),
56        )
57        .run_with_handle(|ui| {
58            std::thread::spawn(move || {
59                // Replace this with blocking I/O or CPU work.
60                ui.send_application(WORK_FINISHED, "loaded".to_string());
61            });
62        })
63}

Trait Implementations§

Source§

impl Clone for CommandSender

Source§

fn clone(&self) -> CommandSender

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 CommandSender

Source§

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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

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