Struct piper::Event

pub struct Event { /* fields omitted */ }

A synchronization primitive for notifying async tasks and threads.

Listeners can be registered using [listen()][Event::listen()]. There are two ways of notifying listeners:

1. [notify_one()][Event::notify_one()] notifies one listener.
2. [notify_all()][Event::notify_all()] notifies all listeners.

If there are no active listeners at the time a notification is sent, it simply gets lost.

Note that [notify_one()][Event::notify_one()] does not notify one additional listener - it only makes sure at least one listener among the active ones is notified.

There are two ways for a listener to wait for a notification:

1. In an asynchronous manner using .await.
2. In a blocking manner by calling [wait()][EventListener::wait()] on it.

If a notified listener is dropped without ever waiting for a notification, dropping will notify another another active listener.

Listeners are registered and notified in the first-in first-out fashion, ensuring fairness.

Methods

impl Event

pub fn new() -> Event

Creates a new [Event].

pub fn listen(&self) -> EventListener

Returns a guard listening for a notification.

pub fn notify_one(&self)

Notifies a single active listener.

Note that this does not notify one additional listener - it only makes sure at least one listener among the active ones is notified.

pub fn notify_all(&self)

Notifies all active listeners.

Trait Implementations

impl Default for Event

fn default() -> Event

Returns the "default value" for a type.

impl Drop for Event

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Event

impl Sync for Event