NaxdyOrg/embassy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Document embassy::util::signal & embassy::util

Browse source
This commit is contained in:
Joshua Salzedo 2021-03-24 13:19:05 -07:00
parent 62009150bd
commit 40617fea04
No known key found for this signature in database
GPG key ID: C3D0EB484493B731
2 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
embassy/src/util/mod.rs
View file

@ -1,3 +1,4 @@
//! Async utilities
mod drop_bomb;
mod forever;
mod mutex;

7
embassy/src/util/signal.rs
View file

@ -10,6 +10,9 @@ use crate::executor;
use crate::fmt::panic;
use crate::interrupt::{Interrupt, InterruptExt};
/// Synchronization primitive. Allows creating awaitable signals that may be passed between tasks.
///
/// For more advanced use cases, please consider [futures-intrusive](https://crates.io/crates/futures-intrusive) channels or mutexes.
pub struct Signal<T> {
state: UnsafeCell<State<T>>,
}
@ -29,7 +32,7 @@ impl<T: Send> Signal<T> {
state: UnsafeCell::new(State::None),
}
}
/// Mark this Signal as completed.
pub fn signal(&self, val: T) {
cortex_m::interrupt::free(|_| unsafe {
let state = &mut *self.state.get();
@ -64,10 +67,12 @@ impl<T: Send> Signal<T> {
})
}
/// Future that completes when this Signal has been signaled.
pub fn wait(&self) -> impl Future<Output = T> + '_ {
futures::future::poll_fn(move |cx| self.poll_wait(cx))
}
/// non-blocking method to check whether this signal has been signaled.
pub fn signaled(&self) -> bool {
cortex_m::interrupt::free(|_| matches!(unsafe { &*self.state.get() }, State::Signaled(_)))
}