karyon_core::async_util

Struct CondVar

Source
pub struct CondVar {
    inner: Mutex<Wakers>,
}
Expand description

CondVar is an async version of https://doc.rust-lang.org/std/sync/struct.Condvar.html

§Example

 use std::sync::Arc;

 use karyon_core::async_util::CondVar;
 use karyon_core::async_runtime::{spawn, lock::Mutex};

  async {
     
     let val = Arc::new(Mutex::new(false));
     let condvar = Arc::new(CondVar::new());

     spawn({
         let val = val.clone();
         let condvar = condvar.clone();
         async move {
             let mut val = val.lock().await;

             // While the boolean flag is false, wait for a signal.
             while !*val {
                 val = condvar.wait(val).await;
             }

             // ...
         }
     });

     spawn({
         let condvar = condvar.clone();
         async move {
             let mut val = val.lock().await;

             // While the boolean flag is false, wait for a signal.
             while !*val {
                 val = condvar.wait(val).await;
             }

             // ...
         }
     });
     
     // Wake up all waiting tasks on this condvar
     condvar.broadcast();
  };

Fields§

§inner: Mutex<Wakers>

Implementations§

Source§

impl CondVar

Source

pub fn new() -> Self

Creates a new CondVar

Source

pub async fn wait<'a, T>(&self, g: MutexGuard<'a, T>) -> MutexGuard<'a, T>

Blocks the current task until this condition variable receives a notification.

Source

pub fn signal(&self)

Wakes up one blocked task waiting on this condvar.

Source

pub fn broadcast(&self)

Wakes up all blocked tasks waiting on this condvar.

Trait Implementations§

Source§

impl Default for CondVar

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more