pub struct Signal<T> { /* private fields */ }Expand description
Cloneable observable storage with equality-deduplicated writes.
Every write that changes the value increments version
and notifies observers on the writing thread (see the
crate-level threading notes).
Closures passed to with, update, and
modify run while the value is locked, so they must not
write to the same signal. Debug builds panic, naming the signal, instead
of deadlocking.
Implementations§
Source§impl<T> Signal<T>
impl<T> Signal<T>
pub fn new(value: T) -> Signal<T>
Sourcepub fn named(name: impl Into<Arc<str>>, value: T) -> Signal<T>
pub fn named(name: impl Into<Arc<str>>, value: T) -> Signal<T>
Examples found in repository?
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 .gap(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}pub fn source_id(&self) -> SourceId
pub fn source_name(&self) -> Arc<str> ⓘ
Sourcepub fn with<R>(&self, read: impl FnOnce(&T) -> R) -> R
pub fn with<R>(&self, read: impl FnOnce(&T) -> R) -> R
Read the current value by reference without cloning it.
Sourcepub fn set(&self, value: T) -> boolwhere
T: PartialEq,
pub fn set(&self, value: T) -> boolwhere
T: PartialEq,
Examples found in repository?
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 .gap(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}Sourcepub fn update(&self, update: impl FnOnce(&mut T)) -> bool
pub fn update(&self, update: impl FnOnce(&mut T)) -> bool
Mutate the value and notify if it differs from before.
This clones the value to compare it. For large values use
modify, which lets the closure report the change.
Sourcepub fn modify(&self, modify: impl FnOnce(&mut T) -> bool) -> bool
pub fn modify(&self, modify: impl FnOnce(&mut T) -> bool) -> bool
Mutate the value in place without cloning or comparing it.
Observers are notified only when modify returns true.
Sourcepub fn mark_changed(&self)
pub fn mark_changed(&self)
Increment the version and notify observers without touching the value.
Use after changing state the signal cannot see, such as data behind interior mutability, or as a revision bump for values without cheap equality.
Sourcepub fn subscribe(&self, observer: Observer) -> Subscription
pub fn subscribe(&self, observer: Observer) -> Subscription
Observe changes. Unlike Observable::subscribe, this does not
require T: Clone.
Sourcepub fn changed(&self) -> Changed ⓘ
pub fn changed(&self) -> Changed ⓘ
A future that resolves at the next change; see Observable::changed.
Unlike the trait method, this does not require T: Clone.
pub fn select<U>( &self, select: impl Fn(&T) -> U + Send + Sync + 'static, ) -> Selector<Signal<T>, T, U>
pub fn select_named<U>( &self, name: impl Into<Arc<str>>, select: impl Fn(&T) -> U + Send + Sync + 'static, ) -> Selector<Signal<T>, T, U>
Source§impl<T> Signal<Arc<T>>
impl<T> Signal<Arc<T>>
Sourcepub fn set_arc(&self, value: Arc<T>) -> bool
pub fn set_arc(&self, value: Arc<T>) -> bool
Replace the shared value, deduplicating by pointer rather than by
value equality. get then only clones the Arc.
Sourcepub fn modify_arc(&self, modify: impl FnOnce(&mut T) -> bool) -> boolwhere
T: Clone,
pub fn modify_arc(&self, modify: impl FnOnce(&mut T) -> bool) -> boolwhere
T: Clone,
Mutate the shared value through Arc::make_mut: in place when no
reader holds the current snapshot, otherwise on a fresh copy so the
snapshots readers hold stay unchanged.
Observers are notified only when modify returns true.
Trait Implementations§
Source§impl<T> Observable<T> for Signal<T>where
T: Clone + 'static,
impl<T> Observable<T> for Signal<T>where
T: Clone + 'static,
fn source_id(&self) -> SourceId
fn source_name(&self) -> Arc<str> ⓘ
fn get(&self) -> T
Source§fn read(&self, reader: &mut dyn FnMut(&T))
fn read(&self, reader: &mut dyn FnMut(&T))
reader once with a borrow of the current value. Read moreSource§fn value_version(&self) -> Option<u64>
fn value_version(&self) -> Option<u64>
None if unknown. Read morefn subscribe(&self, observer: Observer) -> Subscription
Auto Trait Implementations§
impl<T> Forget for Signal<T>
impl<T> Freeze for Signal<T>
impl<T> Move for Signal<T>
impl<T> RefUnwindSafe for Signal<T>where
Arc<SignalInner<T>>: RefUnwindSafe,
impl<T> Send for Signal<T>
impl<T> Sync for Signal<T>
impl<T> Unpin for Signal<T>
impl<T> UnsafeUnpin for Signal<T>where
Arc<SignalInner<T>>: UnsafeUnpin,
impl<T> UnwindSafe for Signal<T>where
Arc<SignalInner<T>>: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.