Struct itron_solid_fmp3::semaphore::Semaphore

pub struct Semaphore(_);

This is supported on crate features unstable and dcre only.

An owned semaphore.

Deletes the semaphore automatically when dropped. The destructor will panic if the deletion fails.

Implementations

impl Semaphore

pub fn build() -> Builder

acre_sem: Create a builder for Semaphore.

Examples

use itron::semaphore::Semaphore;
let binary_semaphore = Semaphore::build()
    .finish()
    .expect("failed to create a semaphore");

binary_semaphore.as_ref().wait()
   .expect("failed to perform a wait operation");
binary_semaphore.as_ref().signal()
   .expect("failed to perform a signal operation");

use itron::{semaphore::Semaphore, wait::QueueOrder};
let counting_semaphore = Semaphore::build()
    .initial_count(4)
    .max_count(8)
    .queue_order(QueueOrder::TaskPriority)
    .finish()
    .expect("failed to create a semaphore");

for _ in 0..4 {
    counting_semaphore.as_ref().poll()
       .expect("failed to perform a polling wait operation");
}
counting_semaphore.as_ref().poll()
   .expect_err("unexpectedly succeeded to perform a polling wait operation");

for _ in 0..8 {
    counting_semaphore.as_ref().signal()
       .expect("failed to perform a signal operation");
}
counting_semaphore.as_ref().signal()
   .expect_err("unexpectedly succeeded to perform a signal operation");

impl Semaphore

pub const unsafe fn from_raw_nonnull(id: NonNullID) -> Self

Construct a Semaphore from a raw object ID.

Safety

See Object ID Wrappers.

pub const fn leak<'a>(self) -> SemaphoreRef<'a>

Consume and “leak” self, returning a reference SemaphoreRef<'a>.

pub const fn as_raw(&self) -> ID

Get the raw object ID.

pub const fn as_raw_nonnull(&self) -> NonNullID

Get the raw object ID as abi::NonNullID.

pub const fn as_ref(&self) -> SemaphoreRef<'_>

Borrow Semaphore as SemaphoreRef.

Use this to perform operations on semaphores because most of the methods are implemented on SemaphoreRef but not Semaphore.

Trait Implementations

impl Debug for Semaphore

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

Formats the value using the given formatter.

impl Drop for Semaphore

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Semaphore> for Semaphore

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

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

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

This method tests for !=.

impl Eq for Semaphore

impl StructuralEq for Semaphore

impl StructuralPartialEq for Semaphore