Struct Event

pub struct Event { /* private fields */ }

Available on crate feature threading only.

An Event, allowing to notify multiple threads that some event has happened.

An Event manages an internal flag that can be set to true with the Self::set() method and reset to false with the Self::clear() method. The Self::wait() method blocks until the flag is set to true. The flag is set to false initially.

Implementations

impl Event

pub const fn new() -> Event

Creates a new unset Event.

pub const fn new_set() -> Event

Creates a new set Event.

pub fn is_set(&self) -> bool

Returns whether the Event is set.

pub fn wait(&self)

Waits for this Event to be set (blocking).

If the event was set, this function returns directly. If the event was unset, this function will block the current thread until the event gets set elsewhere.

Panics

Panics if this is called outside of a thread context.

pub fn clear(&self) -> bool

Clears the event (non-blocking).

If the event was set, it will be cleared and the function returns true. If the event was unset, the function returns false.

pub fn set(&self)

Sets the event.

If the event was unset, and there were waiters, all waiters will be woken up. If the event was already set, the function just returns.

Trait Implementations

impl Default for Event

fn default() -> Event

Returns the “default value” for a type.

impl Sync for Event