Skip to main content

Signal

Struct Signal 

Source
pub struct Signal<T> { /* private fields */ }
Expand description

One-shot signal carrying a value to a single waiter.

The value is produced by the receive path and consumed by the procedure waiting for it; it stays available until taken, so a signal that arrives before anyone waits is not lost.

Implementations§

Source§

impl<T> Signal<T>

Source

pub const fn new() -> Self

Creates a signal holding no value.

Source

pub fn signal(&self, value: T)

Store the value and wake the waiter, replacing an unconsumed one.

Source

pub fn reset(&self)

Discard a pending, unconsumed value.

Source

pub fn try_take(&self) -> Option<T>

Take the value without waiting, if one is pending.

Source

pub fn is_signaled(&self) -> bool

Whether a value is pending.

Source

pub async fn wait(&self) -> T

Wait until signaled, consuming the value.

Trait Implementations§

Source§

impl<T> Default for Signal<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for Signal<T>

§

impl<T> !RefUnwindSafe for Signal<T>

§

impl<T> Send for Signal<T>
where Mutex<Option<T>>: Send,

§

impl<T> Sync for Signal<T>
where Mutex<Option<T>>: Sync,

§

impl<T> Unpin for Signal<T>
where Mutex<Option<T>>: Unpin,

§

impl<T> UnsafeUnpin for Signal<T>

§

impl<T> UnwindSafe for Signal<T>
where Mutex<Option<T>>: UnwindSafe,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.