Struct Event 

pub struct Event { /* private fields */ }

Binary event (signal/wait).

Implementations

impl Event

pub fn new() -> Result<Self>

Create a new event via heap allocation (only in heap mode).

pub fn create(storage: &'static EventStorage) -> Result<Self>

Mode-agnostic constructor (see Mutex::create).

pub fn wait(&self) -> Result<()>

Block indefinitely until the event is signalled.

pub fn try_wait(&self) -> Result<()>

Non-blocking check.

Errors

Returns Error::WouldBlock if the event is not currently signalled.

pub fn wait_for(&self, d: Duration) -> Result<()>

Wait for the event up to d. parking_lot::Condvar::wait_for naming convention (waiting primitives don’t use the try_ prefix in parking_lot).

Errors

Returns Error::Timeout if the event is not signalled within d.

pub fn wait_until(&self, deadline: Instant) -> Result<()>

Wait for the event by the given deadline. Use Instant::FOREVER for an indefinite wait.

Errors

Returns Error::Timeout if the deadline elapses before the event is signalled.

pub fn signal(&self)

Signal the event.

pub fn signal_from_isr(&self)

Signal the event from an ISR context.

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.

impl Drop for Event

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Event

impl Sync for Event