Skip to main content

Cond

Struct Cond 

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

A goroutine-aware condition variable.

Like std::sync::Condvar but parks goroutines instead of OS threads, so other goroutines sharing the same M continue to be scheduled while waiters sleep.

Must be used from within a [go_lib::run] context.

Implementations§

Source§

impl Cond

Source

pub fn new() -> Self

Create a new Cond.

Source

pub fn wait<'a, T>( &self, mu: &'a Mutex<T>, guard: MutexGuard<'a, T>, ) -> MutexGuard<'a, T>

Release guard, park the current goroutine until notified, then re-acquire the mutex and return the new guard.

Spurious wakeups are possible; always re-check the predicate in a loop:

let mut guard = mu.lock().unwrap();
while !*guard {
    guard = cnd.wait(&mu, guard);
}
§Panics

Panics if called from outside a goroutine context (i.e. before run()).

Source

pub fn notify_one(&self)

Wake one waiting goroutine. No-op if there are no waiters.

Source

pub fn notify_all(&self)

Wake all waiting goroutines.

Trait Implementations§

Source§

impl Default for Cond

Source§

fn default() -> Self

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

impl Send for Cond

Source§

impl Sync for Cond

Auto Trait Implementations§

§

impl !Freeze for Cond

§

impl RefUnwindSafe for Cond

§

impl Unpin for Cond

§

impl UnsafeUnpin for Cond

§

impl UnwindSafe for Cond

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.