Struct r3_core::kernel::semaphore::Semaphore

source ·

#[repr(transparent)]
pub struct Semaphore<System: NotSupportedYet>(_);

Expand description

Represents a single semaphore in a system.

This type is ABI-compatible with System::RawSemaphoreId.

See SemaphoreRef for the borrowed counterpart. See SemaphoreMethods for the operations provided by this handle type.

A semaphore maintains a set of permits that can be acquired (possibly blocking) or released by application code. The number of permits held by a semaphore is called the semaphore’s value and represented by SemaphoreValue.

Relation to Other Specifications: Present in almost every real-time operating system.

Trait Implementations

source

impl<System: NotSupportedYet> Debug for Semaphore<System>

source

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

Formats the value using the given formatter. Read more

source

impl<System: NotSupportedYet> Hash for Semaphore<System>

source

fn hash<H>(&self, state: &mut H)where
H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,
Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

source

impl<System: NotSupportedYet> PartialEq<Semaphore<System>> for Semaphore<System>

source

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl<System: NotSupportedYet> PartialEq<Semaphore<System>> for SemaphoreRef<'_, System>

source

fn eq(&self, other: &Semaphore<System>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl<System: NotSupportedYet> PartialEq<SemaphoreRef<'_, System>> for Semaphore<System>

source

fn eq(&self, other: &SemaphoreRef<'_, System>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl<System: NotSupportedYet> SemaphoreHandle for Semaphore<System>

type System = System

The system type this object pertains to.

source

const unsafe fn from_id(id: <System as KernelSemaphore>::RawSemaphoreId) -> Self

Construct a Semaphore from RawSemaphoreId. Read more

source

const fn id(&self) -> System::RawSemaphoreId

Get the raw RawSemaphoreId value representing this object.

source

const fn borrow(&self) -> SemaphoreRef<'_, Self::System>

Borrow self as SemaphoreRef. Read more

source

impl<System: NotSupportedYet> Eq for Semaphore<System>

Auto Trait Implementations

impl<System> RefUnwindSafe for Semaphore<System>where
<System as KernelSemaphore>::RawSemaphoreId: RefUnwindSafe,

impl<System> Send for Semaphore<System>

impl<System> Sync for Semaphore<System>

impl<System> Unpin for Semaphore<System>where
<System as KernelSemaphore>::RawSemaphoreId: Unpin,

impl<System> UnwindSafe for Semaphore<System>where
<System as KernelSemaphore>::RawSemaphoreId: UnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> SemaphoreMethods for Twhere
T: SemaphoreHandle,

source

fn drain(&self) -> Result<(), DrainSemaphoreError>

Remove all permits held by the semaphore.

source

fn get(&self) -> Result<SemaphoreValue, GetSemaphoreError>

Get the number of permits currently held by the semaphore.

source

fn signal(&self, count: SemaphoreValue) -> Result<(), SignalSemaphoreError>

Release count permits, returning them to the semaphore.

source

fn signal_one(&self) -> Result<(), SignalSemaphoreError>

Release a permit, returning it to the semaphore.

source

fn wait_one(&self) -> Result<(), WaitSemaphoreError>

Acquire a permit, potentially blocking the calling thread until one is available. Read more

source

fn wait_one_timeout(
&self,
timeout: Duration
) -> Result<(), WaitSemaphoreTimeoutError>

wait_one with timeout.

source

fn poll_one(&self) -> Result<(), PollSemaphoreError>

Non-blocking version of wait_one. Returns immediately with PollSemaphoreError::Timeout if the unblocking condition is not satisfied. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct r3_core::kernel::semaphore::Semaphore

Trait Implementations

impl<System: NotSupportedYet> Debug for Semaphore<System>

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

impl<System: NotSupportedYet> Hash for Semaphore<System>

fn hash<H>(&self, state: &mut H)where H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl<System: NotSupportedYet> PartialEq<Semaphore<System>> for Semaphore<System>

fn eq(&self, other: &Self) -> bool

fn ne(&self, other: &Rhs) -> bool

impl<System: NotSupportedYet> PartialEq<Semaphore<System>> for SemaphoreRef<'_, System>

fn eq(&self, other: &Semaphore<System>) -> bool

fn ne(&self, other: &Rhs) -> bool

impl<System: NotSupportedYet> PartialEq<SemaphoreRef<'_, System>> for Semaphore<System>

fn eq(&self, other: &SemaphoreRef<'_, System>) -> bool

fn ne(&self, other: &Rhs) -> bool

impl<System: NotSupportedYet> SemaphoreHandle for Semaphore<System>

type System = System

const unsafe fn from_id(id: <System as KernelSemaphore>::RawSemaphoreId) -> Self

const fn id(&self) -> System::RawSemaphoreId

const fn borrow(&self) -> SemaphoreRef<'_, Self::System>

impl<System: NotSupportedYet> Eq for Semaphore<System>

Auto Trait Implementations

impl<System> RefUnwindSafe for Semaphore<System>where <System as KernelSemaphore>::RawSemaphoreId: RefUnwindSafe,

impl<System> Send for Semaphore<System>

impl<System> Sync for Semaphore<System>

impl<System> Unpin for Semaphore<System>where <System as KernelSemaphore>::RawSemaphoreId: Unpin,

impl<System> UnwindSafe for Semaphore<System>where <System as KernelSemaphore>::RawSemaphoreId: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> SemaphoreMethods for Twhere T: SemaphoreHandle,

fn drain(&self) -> Result<(), DrainSemaphoreError>

fn get(&self) -> Result<SemaphoreValue, GetSemaphoreError>

fn signal(&self, count: SemaphoreValue) -> Result<(), SignalSemaphoreError>

fn signal_one(&self) -> Result<(), SignalSemaphoreError>

fn wait_one(&self) -> Result<(), WaitSemaphoreError>

fn wait_one_timeout( &self, timeout: Duration) -> Result<(), WaitSemaphoreTimeoutError>

fn poll_one(&self) -> Result<(), PollSemaphoreError>

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

type Error = Infallible

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

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

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

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

fn hash<H>(&self, state: &mut H)where
H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,
Self: Sized,

impl<System> RefUnwindSafe for Semaphore<System>where
<System as KernelSemaphore>::RawSemaphoreId: RefUnwindSafe,

impl<System> Unpin for Semaphore<System>where
<System as KernelSemaphore>::RawSemaphoreId: Unpin,

impl<System> UnwindSafe for Semaphore<System>where
<System as KernelSemaphore>::RawSemaphoreId: UnwindSafe,

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

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

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

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

impl<T> SemaphoreMethods for Twhere
T: SemaphoreHandle,

fn wait_one_timeout(
&self,
timeout: Duration
) -> Result<(), WaitSemaphoreTimeoutError>

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

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