anglesideangle.dev
wip
fixed race docs
+7
-7
+6
-6
futures-combinators/src/race.rs
+6
-6
futures-combinators/src/race.rs
···
3
3
use std::{cell::Cell, task::Poll};
4
4
5
5
/// from [futures-concurrency](https://github.com/yoshuawuyts/futures-concurrency/tree/main)
6
-
/// Wait for all futures to complete.
6
+
/// Wait for the first future to complete.
7
7
///
8
-
/// Awaits multiple futures simultaneously, returning the output of the futures
9
-
/// in the same container type they were created once all complete.
8
+
/// Awaits multiple future at once, returning as soon as one completes. The
9
+
/// other futures are cancelled.
10
10
pub trait Race<'scope> {
11
11
/// The resulting output type.
12
12
type Output;
···
14
14
/// The [`ScopedFuture`] implementation returned by this method.
15
15
type Future: ScopedFuture<'scope, Output = Self::Output>;
16
16
17
-
/// Waits for multiple futures to complete.
17
+
/// Wait for the first future to complete.
18
18
///
19
-
/// Awaits multiple futures simultaneously, returning the output of the futures
20
-
/// in the same container type they we're created once all complete.
19
+
/// Awaits multiple futures at once, returning as soon as one completes. The
20
+
/// other futures are cancelled.
21
21
///
22
22
/// This function returns a new future which polls all futures concurrently.
23
23
fn race(self) -> Self::Future;