Struct EventGroup 

pub struct EventGroup { /* private fields */ }

Event group — a set of named bits that can be set, cleared, and waited on.

Implementations

impl EventGroup

pub fn new() -> Result<Self>

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

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

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

pub fn set_bits(&self, bits: u32) -> u32

Set bits in the event group. Returns the bits value after setting.

pub fn clear_bits(&self, bits: u32) -> u32

Clear bits in the event group. Returns the bits value before clearing.

pub fn wait_bits(&self, bits: u32, flags: WaitFlags) -> Result<u32>

Wait indefinitely for the specified bits to be set. Returns the bits value at the moment the wait condition was satisfied.

flags is a combination of WaitFlags::WAIT_ALL and WaitFlags::CLEAR_ON_EXIT.

pub fn try_wait_bits(&self, bits: u32, flags: WaitFlags) -> Result<u32>

Non-blocking check for the specified bits.

Errors

Returns Error::Timeout if the bits are not currently set.

pub fn wait_bits_for( &self, bits: u32, flags: WaitFlags, d: Duration, ) -> Result<u32>

Wait up to d for the specified bits.

pub fn wait_bits_until( &self, bits: u32, flags: WaitFlags, deadline: Instant, ) -> Result<u32>

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

pub fn set_bits_from_isr(&self, bits: u32) -> u32

Set bits from an ISR context. Returns the bits value after setting.

pub fn get_bits(&self) -> u32

Get current bits value.

pub unsafe fn set_notify( &self, cb: Option<unsafe extern "C" fn(*mut c_void)>, user_data: *mut c_void, ) -> Result<()>

Register a notify callback fired after every successful set_bits. Wraps the C-level ove_eventgroup_set_notify.

Safety

Same as crate::Stream::set_notify: user_data must remain valid for as long as the callback may fire, and cb must be ISR-safe (the C-side invokes it from whatever context the set ran in, thread or ISR).

Trait Implementations

impl Debug for EventGroup

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

Formats the value using the given formatter.

impl Drop for EventGroup

fn drop(&mut self)

Executes the destructor for this type.

impl Send for EventGroup

impl Sync for EventGroup