Semaphore

Struct Semaphore 

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

A counting or binary semaphore

Implementations§

Source§

impl Semaphore

Source

pub fn new_binary() -> Result<Semaphore, FreeRtosError>

Create a new binary semaphore

Source

pub fn new_counting(max: u32, initial: u32) -> Result<Semaphore, FreeRtosError>

Create a new counting semaphore

Source

pub unsafe fn from_raw_handle(handle: FreeRtosSemaphoreHandle) -> Self

§Safety

handle must be a valid FreeRTOS semaphore handle.

Only binary or counting semaphore is expected here. To create mutex from raw handle use crate::mutex::MutexInnerImpl::from_raw_handle.

Source

pub fn raw_handle(&self) -> FreeRtosSemaphoreHandle

Source

pub fn lock<D: DurationTicks>( &self, max_wait: D, ) -> Result<SemaphoreGuard<'_>, FreeRtosError>

Lock this semaphore in a RAII fashion

Source

pub fn give(&self) -> bool

Returns true on success, false when semaphore count already reached its limit

Source

pub fn take<D: DurationTicks>(&self, max_wait: D) -> Result<(), FreeRtosError>

Source

pub fn give_from_isr(&self, context: &mut InterruptContext) -> bool

Returns true on success, false when semaphore count already reached its limit

Source

pub fn take_from_isr(&self, context: &mut InterruptContext) -> bool

Returns true on success, false if the semaphore was not successfully taken because it was not available

Trait Implementations§

Source§

impl Drop for Semaphore

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for Semaphore

Source§

impl Sync for Semaphore

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.