Struct Notify 

pub struct Notify { /* private fields */ }

Notifies a single task to wake up.

Examples

Usage using tokio as an example executor:

use std::sync::Arc;
use asyncsync::Notify;

#[tokio::main]
async fn main() {
    let notify = Arc::new(Notify::new());

    let clone = notify.clone();
    let handle = tokio::task::spawn(async move {
        clone.notified().await;
        println!("Received notification");
    });

    notify.notify_one();

    handle.await.unwrap();
}

Implementations

impl Notify

pub fn new() -> Self

Creates a new Notify without any stored notification.

pub fn notify_all(&self)

Notifies all currently waiting tasks.

Note that notify_all will only wake up all currently waiting tasks and not store any notification for future tasks. If there are no tasks waiting, notify_all does nothing.

pub fn notify_one(&self)

Notifies a single waiting task.

If there are no task waiting, a notification is stored and the next waiting task will complete immediately.

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

Wait for a notification.

Trait Implementations

impl Debug for Notify

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

Formats the value using the given formatter.

impl Default for Notify

fn default() -> Self

Returns the “default value” for a type.

impl Send for Notify

impl Sync for Notify