Struct Semaphore

pub struct Semaphore(/* private fields */);

General Zephyr Semaphores

Implementations

impl Semaphore

pub const fn new(initial_count: c_uint, limit: c_uint) -> Semaphore

Create a new semaphore.

Create a new dynamically allocated Semaphore. This semaphore can only be used from system threads. The arguments are as described in the docs.

Note that this API has changed, and it now doesn’t return a Result, since the Result time generally doesn’t work (in stable rust) with const.

pub fn take<T>(&self, timeout: T) -> Result<()>

where T: Into<Timeout>,

Take a semaphore.

Can be called from ISR if called with NoWait.

pub fn take_async<'a>( &'a self, timeout: impl Into<Timeout>, ) -> impl Future<Output = Result<()>> + 'a

Take a semaphore, async version.

Returns a future that either waits for the semaphore, or returns status.

pub fn give(&self)

Give a semaphore.

This routine gives to the semaphore, unless the semaphore is already at its maximum permitted count.

pub fn reset(&self)

Resets a semaphor’s count to zero.

This resets the count to zero. Any outstanding take calls will be aborted with Error(EAGAIN).

pub fn count_get(&self) -> usize

Get a semaphore’s count.

Returns the current count.

Trait Implementations

impl Debug for Semaphore

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

Formats the value using the given formatter.

impl Send for Semaphore

impl Sync for Semaphore

By nature, Semaphores are both Sync and Send. Safety is handled by the underlying Zephyr implementation (which is why Clone is also implemented).