Struct Event 

pub struct Event { /* private fields */ }

An event that is set once and stays set.

wait completes as soon as the event is set, whether that happened before or after the wait began; set wakes every waiter. Checking is one atomic load.

use nuclei::sync::Event;

let ready = Event::new();
assert!(!ready.is_set());
ready.set();
assert!(ready.is_set());

Implementations

impl Event

pub const fn new() -> Self

An event that is not set.

pub fn set(&self)

Sets the event and wakes every waiter. Setting it again does nothing.

pub fn is_set(&self) -> bool

Whether the event is set.

pub fn wait(&self) -> EventWait<'_>

A future that completes once the event is set.

Trait Implementations

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.

impl Drop for Event

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for Event

impl Sync for Event