EventGroup

Struct EventGroup 

Source
pub struct EventGroup { /* private fields */ }
Expand description

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

Implementations§

Source§

impl EventGroup

Source

pub fn new() -> Result<Self>

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

Source

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

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

Source

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

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

Source

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

Wait for the specified bits to be set in the event group.

flags is a combination of WaitFlags::WAIT_ALL and WaitFlags::CLEAR_ON_EXIT. Returns the bits value at the moment the wait condition was satisfied.

§Errors

Returns Error::Timeout if the bits are not set within timeout_ms.

Source

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

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

Source

pub fn get_bits(&self) -> u32

Get current bits value.

Trait Implementations§

Source§

impl Debug for EventGroup

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for EventGroup

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for EventGroup

Source§

impl Sync for EventGroup

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.