Struct dispatch::Semaphore

pub struct Semaphore { /* private fields */ }

A counting semaphore.

Implementations

impl Semaphore

pub fn new(value: u32) -> Self

Creates a new Semaphore with an initial value.

A Semaphore created with a value greater than 0 cannot be disposed if it has been decremented below its original value. If there are more successful calls to wait than signal, the system assumes the Semaphore is still in use and will abort if it is disposed.

pub fn wait(&self)

Wait for (decrement) self.

pub fn wait_timeout(&self, timeout: Duration) -> Result<(), WaitTimeout>

Wait for (decrement) self until the specified timeout has elapsed.

pub fn signal(&self) -> bool

Signal (increment) self.

If the previous value was less than zero, this method wakes a waiting thread. Returns true if a thread is woken or false otherwise.

pub fn access(&self) -> SemaphoreGuard

Wait to access a resource protected by self. This decrements self and returns a guard that increments when dropped.

pub fn access_timeout( &self, timeout: Duration ) -> Result<SemaphoreGuard, WaitTimeout>

Wait until the specified timeout to access a resource protected by self. This decrements self and returns a guard that increments when dropped.

Trait Implementations

impl Clone for Semaphore

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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 Send for Semaphore

impl Sync for Semaphore