Struct async_task_group::GroupJoinHandle[−][src]

pub struct GroupJoinHandle<E> { /* fields omitted */ }

Expand description

A JoinHandle is used to manage a collection of tasks. There are two things you can do with it:

JoinHandle impls Future, so you can poll or await on it. It will be Ready when all tasks return Ok(()) and the associated TaskGroup is dropped (so no more tasks can be created), or when any task panicks or returns an Err(E).
When a JoinHandle is dropped, all tasks it contains are canceled (terminated). So, if you use a combinator like tokio::time::timeout(duration, task_manager).await, all tasks will be terminated if the timeout occurs.

Trait Implementations

[src]

impl<E: Debug> Debug for GroupJoinHandle<E>

[src]

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

Formats the value using the given formatter. Read more

[src]

impl<E> Future for GroupJoinHandle<E>

type Output = Result<(), E>

The type of value produced on completion.

[src]

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

Attempt 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

impl<E> RefUnwindSafe for GroupJoinHandle<E>

impl<E> Send for GroupJoinHandle<E> where
E: Send,

impl<E> Sync for GroupJoinHandle<E> where
E: Send,

impl<E> Unpin for GroupJoinHandle<E>

impl<E> UnwindSafe for GroupJoinHandle<E>

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> FutureExt for T where
T: Future + ?Sized,

[src]

fn delay(self, dur: Duration) -> DelayFuture<Self>

Returns a Future that delays execution for a specified time. Read more

[src]

fn flatten(self) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future> where
Self::Output: IntoFuture,

Flatten out the execution of this future when the result itself can be converted into another future. Read more

[src]

fn race<F>(self, other: F) -> Race<Self, F> where
Self: Future,
F: Future<Output = Self::Output>,

Waits for one of two similarly-typed futures to complete. Read more

[src]

fn try_race<F, T, E>(self, other: F) -> TryRace<Self, F> where
Self: Future<Output = Result<T, E>>,
F: Future<Output = Self::Output>,

Waits for one of two similarly-typed fallible futures to complete. Read more

[src]

fn join<F>(self, other: F) -> Join<Self, F> where
Self: Future,
F: Future,

Waits for two similarly-typed futures to complete. Read more

[src]

fn try_join<F, A, B, E>(self, other: F) -> TryJoin<Self, F> where
Self: Future<Output = Result<A, E>>,
F: Future<Output = Result<B, E>>,

Waits for two similarly-typed fallible futures to complete. Read more

[src]

fn timeout(self, dur: Duration) -> TimeoutFuture<Self>

Waits for both the future and a timeout, if the timeout completes before the future, it returns an TimeoutError. Read more

impl<F> FutureExt for F where
F: Future + ?Sized,

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

A convenience for calling Future::poll() on !Unpin types.

fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,

Returns the result of self or other future, preferring self if both are ready. Read more

fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,

Returns the result of self or other future, with no preference if both are ready. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

Catches panics while polling the future. Read more

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

Boxes the future and changes its type to dyn Future + Send + 'a. Read more

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

Boxes the future and changes its type to dyn Future + 'a. Read more

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<F> IntoFuture for F where
F: Future,

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

[src]

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

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

[src]

impl<T> IntoFuture for T where
T: Future,

type Output = <T as Future>::Output

The type of value produced on completion.

type Future = T

Which kind of future are we turning this into?

[src]

pub fn into_future(self) -> <T as IntoFuture>::Future

Create a future from a value

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct async_task_group::GroupJoinHandle[−][src]

Trait Implementations

impl<E: Debug> Debug for GroupJoinHandle<E>

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

impl<E> Future for GroupJoinHandle<E>

type Output = Result<(), E>

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

Auto Trait Implementations

impl<E> RefUnwindSafe for GroupJoinHandle<E>

impl<E> Send for GroupJoinHandle<E> where E: Send,

impl<E> Sync for GroupJoinHandle<E> where E: Send,

impl<E> Unpin for GroupJoinHandle<E>

impl<E> UnwindSafe for GroupJoinHandle<E>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> FutureExt for T where T: Future + ?Sized,

fn delay(self, dur: Duration) -> DelayFuture<Self>

fn flatten(self) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future> where Self::Output: IntoFuture,

fn race<F>(self, other: F) -> Race<Self, F> where Self: Future, F: Future<Output = Self::Output>,

fn try_race<F, T, E>(self, other: F) -> TryRace<Self, F> where Self: Future<Output = Result<T, E>>, F: Future<Output = Self::Output>,

fn join<F>(self, other: F) -> Join<Self, F> where Self: Future, F: Future,

fn try_join<F, A, B, E>(self, other: F) -> TryJoin<Self, F> where Self: Future<Output = Result<A, E>>, F: Future<Output = Result<B, E>>,

fn timeout(self, dur: Duration) -> TimeoutFuture<Self>

impl<F> FutureExt for F where F: Future + ?Sized,

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

fn or<F>(self, other: F) -> Or<Self, F> where F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F> where F: Future<Output = Self::Output>,

fn catch_unwind(self) -> CatchUnwind<Self> where Self: UnwindSafe,

fn boxed<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where Self: 'a + Send,

fn boxed_local<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where Self: 'a,

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

pub fn into(self) -> U

impl<F> IntoFuture for F where F: Future,

type Output = <F as Future>::Output

type Future = F

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

impl<T> IntoFuture for T where T: Future,

type Output = <T as Future>::Output

type Future = T

pub fn into_future(self) -> <T as IntoFuture>::Future

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

type Error = Infallible

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

impl<F, T, E> TryFuture for F where F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

type Error = E

pub fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>) -> Poll<<F as Future>::Output>

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

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

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

impl<E> Send for GroupJoinHandle<E> where
E: Send,

impl<E> Sync for GroupJoinHandle<E> where
E: Send,

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

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

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

impl<T> FutureExt for T where
T: Future + ?Sized,

fn flatten(self) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future> where
Self::Output: IntoFuture,

fn race<F>(self, other: F) -> Race<Self, F> where
Self: Future,
F: Future<Output = Self::Output>,

fn try_race<F, T, E>(self, other: F) -> TryRace<Self, F> where
Self: Future<Output = Result<T, E>>,
F: Future<Output = Self::Output>,

fn join<F>(self, other: F) -> Join<Self, F> where
Self: Future,
F: Future,

fn try_join<F, A, B, E>(self, other: F) -> TryJoin<Self, F> where
Self: Future<Output = Result<A, E>>,
F: Future<Output = Result<B, E>>,

impl<F> FutureExt for F where
F: Future + ?Sized,

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

fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

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

impl<F> IntoFuture for F where
F: Future,

impl<T> IntoFuture for T where
T: Future,

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

impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,

pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

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