use core::pin::Pin; use core::task::{Context, Poll}; use futures_core::future::{FusedFuture, Future}; use futures_core::stream::{FusedStream, Stream}; #[cfg(feature = "sink")] use futures_sink::Sink;
/// Combines two different futures, streams, or sinks having the same associated types into a single type. /// /// This is useful when conditionally choosing between two distinct future types: /// /// ```rust /// use futures::future::Either; /// /// # futures::executor::block_on(async { /// let cond = true; /// /// let fut = if cond { /// Either::Left(async move { 12 }) /// } else { /// Either::Right(async move { 44 }) /// }; /// /// assert_eq!(fut.await, 12); /// # }) /// ``` #[derive(Debug, Clone)] pubenum Either<A, B> { /// First branch of the type
Left(/* #[pin] */ A), /// Second branch of the type
Right(/* #[pin] */ B),
}
impl<A, B> Either<A, B> { /// Convert `Pin<&Either<A, B>>` to `Either<Pin<&A>, Pin<&B>>`, /// pinned projections of the inner variants. pubfn as_pin_ref(self: Pin<&Self>) -> Either<Pin<&A>, Pin<&B>> { // SAFETY: We can use `new_unchecked` because the `inner` parts are // guaranteed to be pinned, as they come from `self` which is pinned. unsafe { match *Pin::get_ref(self) {
Either::Left(ref inner) => Either::Left(Pin::new_unchecked(inner)),
Either::Right(ref inner) => Either::Right(Pin::new_unchecked(inner)),
}
}
}
/// Convert `Pin<&mut Either<A, B>>` to `Either<Pin<&mut A>, Pin<&mut B>>`, /// pinned projections of the inner variants. pubfn as_pin_mut(self: Pin<&mutSelf>) -> Either<Pin<&mut A>, Pin<&mut B>> { // SAFETY: `get_unchecked_mut` is fine because we don't move anything. // We can use `new_unchecked` because the `inner` parts are guaranteed // to be pinned, as they come from `self` which is pinned, and we never // offer an unpinned `&mut A` or `&mut B` through `Pin<&mut Self>`. We // also don't have an implementation of `Drop`, nor manual `Unpin`. unsafe { match *Pin::get_unchecked_mut(self) {
Either::Left(refmut inner) => Either::Left(Pin::new_unchecked(inner)),
Either::Right(refmut inner) => Either::Right(Pin::new_unchecked(inner)),
}
}
}
}
impl<A, B, T> Either<(T, A), (T, B)> { /// Factor out a homogeneous type from an either of pairs. /// /// Here, the homogeneous type is the first element of the pairs. pubfn factor_first(self) -> (T, Either<A, B>) { matchself {
Either::Left((x, a)) => (x, Either::Left(a)),
Either::Right((x, b)) => (x, Either::Right(b)),
}
}
}
impl<A, B, T> Either<(A, T), (B, T)> { /// Factor out a homogeneous type from an either of pairs. /// /// Here, the homogeneous type is the second element of the pairs. pubfn factor_second(self) -> (Either<A, B>, T) { matchself {
Either::Left((a, x)) => (Either::Left(a), x),
Either::Right((b, x)) => (Either::Right(b), x),
}
}
}
impl<T> Either<T, T> { /// Extract the value of an either over two equivalent types. pubfn into_inner(self) -> T { matchself {
Either::Left(x) => x,
Either::Right(x) => x,
}
}
}
impl<A, B> Future for Either<A, B> where
A: Future,
B: Future<Output = A::Output>,
{ type Output = A::Output;
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.