aboutsummaryrefslogtreecommitdiff
path: root/embassy-sync/src/watch.rs
diff options
context:
space:
mode:
authorJuliDi <[email protected]>2025-05-04 16:31:26 +0200
committerJuliDi <[email protected]>2025-05-04 16:31:26 +0200
commit723ebfcb4f17e48f2a614f0e1e124e8da9c75b70 (patch)
tree170a6493e95fc2adb7c8bed3e151a1f421234272 /embassy-sync/src/watch.rs
parent9fee43f2bd57e7ce77321d001cdd287f0bd6fef2 (diff)
clarify docs for signal and watch
Diffstat (limited to 'embassy-sync/src/watch.rs')
-rw-r--r--embassy-sync/src/watch.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/embassy-sync/src/watch.rs b/embassy-sync/src/watch.rs
index e76646c0b..08d6a833d 100644
--- a/embassy-sync/src/watch.rs
+++ b/embassy-sync/src/watch.rs
@@ -10,7 +10,7 @@ use crate::blocking_mutex::raw::RawMutex;
10use crate::blocking_mutex::Mutex; 10use crate::blocking_mutex::Mutex;
11use crate::waitqueue::MultiWakerRegistration; 11use crate::waitqueue::MultiWakerRegistration;
12 12
13/// The `Watch` is a single-slot signaling primitive that allows multiple receivers to concurrently await 13/// The `Watch` is a single-slot signaling primitive that allows _multiple_ (`N`) receivers to concurrently await
14/// changes to the value. Unlike a [`Signal`](crate::signal::Signal), `Watch` supports multiple receivers, 14/// changes to the value. Unlike a [`Signal`](crate::signal::Signal), `Watch` supports multiple receivers,
15/// and unlike a [`PubSubChannel`](crate::pubsub::PubSubChannel), `Watch` immediately overwrites the previous 15/// and unlike a [`PubSubChannel`](crate::pubsub::PubSubChannel), `Watch` immediately overwrites the previous
16/// value when a new one is sent, without waiting for all receivers to read the previous value. 16/// value when a new one is sent, without waiting for all receivers to read the previous value.
@@ -298,7 +298,7 @@ impl<M: RawMutex, T: Clone, const N: usize> WatchBehavior<T> for Watch<M, T, N>
298} 298}
299 299
300impl<M: RawMutex, T: Clone, const N: usize> Watch<M, T, N> { 300impl<M: RawMutex, T: Clone, const N: usize> Watch<M, T, N> {
301 /// Create a new `Watch` channel. 301 /// Create a new `Watch` channel for `N` receivers.
302 pub const fn new() -> Self { 302 pub const fn new() -> Self {
303 Self { 303 Self {
304 mutex: Mutex::new(RefCell::new(WatchState { 304 mutex: Mutex::new(RefCell::new(WatchState {