Struct Event 

pub struct Event { /* private fields */ }

A synchronization primitive for notifying tasks in a single-threaded context.

This is similar to event_listener::Event but uses Rc/RefCell instead of thread-safe primitives, making it suitable only for single-threaded use.

Implementations

impl Event

pub fn new() -> Self

Creates a new Event.

Examples

use local_event::Event;

let event = Event::new();

pub fn listen(&self) -> EventListener

Returns a guard listening for a notification. Returned listener can be .await-ed directly.

Examples

use local_event::Event;

let event = Event::new();
event.listen().await;

// Do something after the event is received.

pub fn notify(&self, n: usize)

Notifies a number of active listeners.

The number of notified listeners is determined by n:

• If n is usize::MAX, all active listeners are notified.
• Otherwise, n active listeners are notified.

Examples

use local_event::Event;

let event = Event::new();

// Notify all listeners.
event.notify(usize::MAX);

// Notify exactly 5 listeners.
event.notify(5);

pub fn notify_additional(&self, n: usize)

Notifies a number of active and still waiting listeners.

Unlike notify(), this method only notifies listeners that haven’t been notified yet and are still registered.

Examples

use local_event::Event;

let event = Event::new();
event.notify_additional(2);

pub fn notify_all(&self)

Notifies all active listeners.

This is equivalent to calling notify(usize::MAX).

Examples

use local_event::Event;

let event = Event::new();
let listener1 = event.listen();
let listener2 = event.listen();

// Notify all listeners.
event.notify_all();

assert!(listener1.is_notified());
assert!(listener2.is_notified());

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Default for Event

fn default() -> Self

Returns the “default value” for a type.