Skip to main content

MonoWaitGroup

Struct MonoWaitGroup 

Source
pub struct MonoWaitGroup(/* private fields */);
Expand description

WaitGroup with a single non-clonable group token.

This variant is optimized for scenarios where there is exactly one worker task, and the group token cannot be cloned.

§Cancellation safety

This future is cancellation safe.

It is also safe to poll again after completion.

let (wg, token) = MonoWaitGroup::new();
let mut wg = core::pin::pin!(wg);

assert!(!wg.is_done());

token.release();

wg.as_mut().await;
assert!(wg.is_done());

// It is safe to await again (re-poll)
wg.as_mut().await;
assert!(wg.is_done());

Implementations§

Source§

impl MonoWaitGroup

Source

pub fn new() -> (Self, MonoGroupToken)

Creates a new MonoWaitGroup and a single MonoGroupToken.

Source

pub fn is_done(&self) -> bool

Checks if the MonoWaitGroup has completed.

This returns true if the MonoGroupToken has been dropped.

Trait Implementations§

Source§

impl Debug for MonoWaitGroup

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Future for MonoWaitGroup

Source§

type Output = ()

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. 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, F> GroupTokenExt<T> for F
where T: GroupTokenType, F: Future,

Source§

fn release_on_ready(self, token: T) -> GroupTokenReleaseOnReady<Self, T>

Releases the group token when the future is ready or dropped.
Source§

fn release_on_drop(self, token: T) -> GroupTokenReleaseOnDrop<Self, T>

Releases the group token when the future is dropped. 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<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
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.