mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-12-24 10:59:34 +01:00
Code Issues Projects Releases Packages Wiki Activity

Signal ergo minor fixes (#986)

Browse source 
* rtic_sync::signal: fix some docs typos

* impl Debug for Signal, SignalReader, and SignalWriter

This facilitates e.g. `my_task::spawn(my_signal_reader).unwrap();`
This commit is contained in:
Sebastian Kuzminsky 2024-10-23 12:55:08 -06:00 committed by GitHub
parent 00baf53180
commit 1461977cf7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 38 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
rtic-sync/src/signal.rs
View file

@ -17,6 +17,18 @@ pub struct Signal<T: Copy> {
store: UnsafeCell<Store<T>>,
}
impl<T> core::fmt::Debug for Signal<T>
where
T: core::marker::Copy,
{
fn fmt(&self, fmt: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
fmt.write_fmt(format_args!(
"Signal<{}>{{ .. }}",
core::any::type_name::<T>()
))
}
}
impl<T: Copy> Default for Signal<T> {
fn default() -> Self {
Self::new()
@ -41,12 +53,24 @@ impl<T: Copy> Signal<T> {
}
}
/// Fascilitates the writing of values to a Signal.
/// Facilitates the writing of values to a Signal.
#[derive(Clone)]
pub struct SignalWriter<'a, T: Copy> {
parent: &'a Signal<T>,
}
impl<T> core::fmt::Debug for SignalWriter<'_, T>
where
T: core::marker::Copy,
{
fn fmt(&self, fmt: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
fmt.write_fmt(format_args!(
"SignalWriter<{}>{{ .. }}",
core::any::type_name::<T>()
))
}
}
impl<'a, T: Copy> SignalWriter<'a, T> {
/// Write a raw Store value to the Signal.
fn write_inner(&mut self, value: Store<T>) {
@ -69,11 +93,23 @@ impl<'a, T: Copy> SignalWriter<'a, T> {
}
}
/// Fascilitates the async reading of values from the Signal.
/// Facilitates the async reading of values from the Signal.
pub struct SignalReader<'a, T: Copy> {
parent: &'a Signal<T>,
}
impl<T> core::fmt::Debug for SignalReader<'_, T>
where
T: core::marker::Copy,
{
fn fmt(&self, fmt: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
fmt.write_fmt(format_args!(
"SignalReader<{}>{{ .. }}",
core::any::type_name::<T>()
))
}
}
impl<'a, T: Copy> SignalReader<'a, T> {
/// Immediately read and evict the latest value stored in the Signal.
fn take(&mut self) -> Store<T> {