diff options
| author | ckrenslehner <[email protected]> | 2025-04-26 20:07:30 +0200 |
|---|---|---|
| committer | ckrenslehner <[email protected]> | 2025-04-26 20:11:25 +0200 |
| commit | c2173591aa77ab7aa0a1b3d921883667fb9881f4 (patch) | |
| tree | 558b2c0a6dad1df3f6a570f4167e9e88cc7caaa0 /embassy-sync/src/waitqueue/atomic_waker_turbo.rs | |
| parent | 572e788b2e878436bde527ad66cf561775cebc66 (diff) | |
docs: extend the waker documentation
Diffstat (limited to 'embassy-sync/src/waitqueue/atomic_waker_turbo.rs')
| -rw-r--r-- | embassy-sync/src/waitqueue/atomic_waker_turbo.rs | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/embassy-sync/src/waitqueue/atomic_waker_turbo.rs b/embassy-sync/src/waitqueue/atomic_waker_turbo.rs index 5c6a96ec8..c06b83056 100644 --- a/embassy-sync/src/waitqueue/atomic_waker_turbo.rs +++ b/embassy-sync/src/waitqueue/atomic_waker_turbo.rs | |||
| @@ -4,6 +4,9 @@ use core::sync::atomic::{AtomicPtr, Ordering}; | |||
| 4 | use core::task::Waker; | 4 | use core::task::Waker; |
| 5 | 5 | ||
| 6 | /// Utility struct to register and wake a waker. | 6 | /// Utility struct to register and wake a waker. |
| 7 | /// If a waker is registered, registering another waker will replace the previous one without waking it. | ||
| 8 | /// The intended use case is to wake tasks from interrupts. Therefore, it is generally not expected, | ||
| 9 | /// that multiple tasks register try to register a waker simultaneously. | ||
| 7 | pub struct AtomicWaker { | 10 | pub struct AtomicWaker { |
| 8 | waker: AtomicPtr<()>, | 11 | waker: AtomicPtr<()>, |
| 9 | } | 12 | } |
