Struct safina::SelectFuture
source · [−]pub struct SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
FutA: 'static + Future<Output = A> + Send + Unpin,
FutB: 'static + Future<Output = B> + Send + Unpin,
FutC: 'static + Future<Output = C> + Send + Unpin,
FutD: 'static + Future<Output = D> + Send + Unpin,
FutE: 'static + Future<Output = E> + Send + Unpin, { /* private fields */ }
Expand description
A future that polls two futures and returns the value from the one that completes first.
Implementations
sourceimpl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
FutA: 'static + Future<Output = A> + Send + Unpin,
FutB: 'static + Future<Output = B> + Send + Unpin,
FutC: 'static + Future<Output = C> + Send + Unpin,
FutD: 'static + Future<Output = D> + Send + Unpin,
FutE: 'static + Future<Output = E> + Send + Unpin,
impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
FutA: 'static + Future<Output = A> + Send + Unpin,
FutB: 'static + Future<Output = B> + Send + Unpin,
FutC: 'static + Future<Output = C> + Send + Unpin,
FutD: 'static + Future<Output = D> + Send + Unpin,
FutE: 'static + Future<Output = E> + Send + Unpin,
sourcepub fn new(
a: FutA,
b: FutB,
c: FutC,
d: FutD,
e: FutE
) -> SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>ⓘNotable traits for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Future for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
FutA: 'static + Future<Output = A> + Send + Unpin,
FutB: 'static + Future<Output = B> + Send + Unpin,
FutC: 'static + Future<Output = C> + Send + Unpin,
FutD: 'static + Future<Output = D> + Send + Unpin,
FutE: 'static + Future<Output = E> + Send + Unpin, type Output = OptionAbcde<A, B, C, D, E>;
pub fn new(
a: FutA,
b: FutB,
c: FutC,
d: FutD,
e: FutE
) -> SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>ⓘNotable traits for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Future for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
FutA: 'static + Future<Output = A> + Send + Unpin,
FutB: 'static + Future<Output = B> + Send + Unpin,
FutC: 'static + Future<Output = C> + Send + Unpin,
FutD: 'static + Future<Output = D> + Send + Unpin,
FutE: 'static + Future<Output = E> + Send + Unpin, type Output = OptionAbcde<A, B, C, D, E>;
FutA: 'static + Future<Output = A> + Send + Unpin,
FutB: 'static + Future<Output = B> + Send + Unpin,
FutC: 'static + Future<Output = C> + Send + Unpin,
FutD: 'static + Future<Output = D> + Send + Unpin,
FutE: 'static + Future<Output = E> + Send + Unpin, type Output = OptionAbcde<A, B, C, D, E>;
Makes a future that awaits all of the provided futures, and returns the value from the one that completes first.
Note that they must be
Unpin
.
Use std::boxed::Box::pin
to make them Unpin.
Or use pin_utils::pin_mut
to do it with unsafe code that does not allocate memory.
Trait Implementations
sourceimpl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Future for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
FutA: 'static + Future<Output = A> + Send + Unpin,
FutB: 'static + Future<Output = B> + Send + Unpin,
FutC: 'static + Future<Output = C> + Send + Unpin,
FutD: 'static + Future<Output = D> + Send + Unpin,
FutE: 'static + Future<Output = E> + Send + Unpin,
impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Future for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
FutA: 'static + Future<Output = A> + Send + Unpin,
FutB: 'static + Future<Output = B> + Send + Unpin,
FutC: 'static + Future<Output = C> + Send + Unpin,
FutD: 'static + Future<Output = D> + Send + Unpin,
FutE: 'static + Future<Output = E> + Send + Unpin,
type Output = OptionAbcde<A, B, C, D, E>
type Output = OptionAbcde<A, B, C, D, E>
The type of value produced on completion.
sourcepub fn poll(
self: Pin<&mut SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>>,
cx: &mut Context<'_>
) -> Poll<<SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> as Future>::Output>
pub fn poll(
self: Pin<&mut SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>>,
cx: &mut Context<'_>
) -> Poll<<SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> as Future>::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<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> RefUnwindSafe for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
FutA: RefUnwindSafe,
FutB: RefUnwindSafe,
FutC: RefUnwindSafe,
FutD: RefUnwindSafe,
FutE: RefUnwindSafe,
impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Send for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>
impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Sync for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
FutA: Sync,
FutB: Sync,
FutC: Sync,
FutD: Sync,
FutE: Sync,
impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Unpin for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>
impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> UnwindSafe for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
FutA: UnwindSafe,
FutB: UnwindSafe,
FutC: UnwindSafe,
FutD: UnwindSafe,
FutE: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<F> IntoFuture for F where
F: Future,
impl<F> IntoFuture for F where
F: Future,
type Output = <F as Future>::Output
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
type Future = F
🔬 This is a nightly-only experimental API. (
into_future
)Which kind of future are we turning this into?
sourcepub fn into_future(self) -> <F as IntoFuture>::Future
pub fn into_future(self) -> <F as IntoFuture>::Future
🔬 This is a nightly-only experimental API. (
into_future
)Creates a future from a value.