rtic_sync::signal

Struct SignalReader

source
pub struct SignalReader<'a, T: Copy> { /* private fields */ }
Expand description

Facilitates the async reading of values from the Signal.

Implementations§

source§

impl<'a, T: Copy> SignalReader<'a, T>

source

pub fn try_read(&mut self) -> Option<T>

Returns a pending value if present, or None if no value is available.

Upon read, the stored value is evicted.

source

pub async fn wait(&mut self) -> T

Wait for a new value to be written and read it.

If a value is already pending it will be returned immediately.

Upon read, the stored value is evicted.

source

pub async fn wait_fresh(&mut self) -> T

Wait for a new value to be written and read it.

If a value is already pending, it will be evicted and a new value must be written for the wait to resolve.

Upon read, the stored value is evicted.

Trait Implementations§

source§

impl<T> Debug for SignalReader<'_, T>
where T: Copy,

source§

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for SignalReader<'a, T>

§

impl<'a, T> !RefUnwindSafe for SignalReader<'a, T>

§

impl<'a, T> Send for SignalReader<'a, T>

§

impl<'a, T> Sync for SignalReader<'a, T>

§

impl<'a, T> Unpin for SignalReader<'a, T>

§

impl<'a, T> !UnwindSafe for SignalReader<'a, T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.