Skip to main content

Notify

Struct Notify 

Source
pub struct Notify { /* private fields */ }
Expand description

A notification primitive commonly used to hand-wake another async task/structure — e.g. signaling “state changed, go re-check” without a full channel.

Implementations§

Source§

impl Notify

Source

pub const fn new() -> Self

Create a Notify with no stored permit and no waiters.

Source

pub fn notify_one(&self)

Wake one waiting notified().await, or — if none is currently waiting — store a permit so the next notified().await returns immediately without waiting at all.

Source

pub fn notify_waiters(&self)

Wake every task currently waiting in notified().await. Does not store a permit — a task that calls notified() after this returns will wait for a future notification, not this one.

Source

pub const fn notified(&self) -> Notified<'_>

A future that resolves once this Notify is notified — either a stored permit is consumed immediately, or a future notify_one/notify_waiters wakes it.

Trait Implementations§

Source§

impl Default for Notify

Source§

fn default() -> Self

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

Auto Trait Implementations§

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.