Struct RawThreadCounter

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

The internal implementation of the thread counter.

This struct handles the actual counting and synchronization mechanisms.

Implementations§

Source§

impl RawThreadCounter

Source

pub fn increment(&self)

Increments the thread counter.

§Note

It’s preferable to use ThreadCounter::ticket() instead, which ensures that the count is automatically decremented when the ticket is dropped.

Source

pub fn decrement(&self)

Decrements the thread counter.

If the count reaches zero, it notifies all waiting threads.

§Note

It’s preferable to use ThreadCounter::ticket() instead, which ensures that the count is automatically decremented when the ticket is dropped.

Source

pub fn wait(&self, timeout: impl Into<Option<Duration>>) -> bool

Waits for the counter to reach zero, with an optional timeout.

§Arguments
  • timeout - An optional duration to wait. If None, waits indefinitely.
§Returns
  • true if the count reached zero.
  • false if the timeout was reached before the count reached zero.

Trait Implementations§

Source§

impl AsRef<RawThreadCounter> for ThreadCounter

Source§

fn as_ref(&self) -> &RawThreadCounter

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Default for RawThreadCounter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.