Enum futures_util::future::Either [−][src]
pub enum Either<A, B> { Left(A), Right(B), }
Expand description
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:
use futures::future::Either; let cond = true; let fut = if cond { Either::Left(async move { 12 }) } else { Either::Right(async move { 44 }) }; assert_eq!(fut.await, 12);
Variants
Expand description
First branch of the type
Expand description
Second branch of the type
Implementations
impl<A, B, T> Either<(T, A), (T, B)>
[src]
impl<A, B, T> Either<(T, A), (T, B)>
[src]pub fn factor_first(self) -> (T, Either<A, B>)
[src]
pub fn factor_first(self) -> (T, Either<A, B>)
[src]Factor out a homogeneous type from an either of pairs.
Here, the homogeneous type is the first element of the pairs.
impl<A, B, T> Either<(A, T), (B, T)>
[src]
impl<A, B, T> Either<(A, T), (B, T)>
[src]pub fn factor_second(self) -> (Either<A, B>, T)
[src]
pub fn factor_second(self) -> (Either<A, B>, T)
[src]Factor out a homogeneous type from an either of pairs.
Here, the homogeneous type is the second element of the pairs.
impl<T> Either<T, T>
[src]
impl<T> Either<T, T>
[src]pub fn into_inner(self) -> T
[src]
pub fn into_inner(self) -> T
[src]Extract the value of an either over two equivalent types.
Trait Implementations
impl<A, B> AsyncBufRead for Either<A, B> where
A: AsyncBufRead,
B: AsyncBufRead,
[src]
impl<A, B> AsyncBufRead for Either<A, B> where
A: AsyncBufRead,
B: AsyncBufRead,
[src]impl<A, B> AsyncRead for Either<A, B> where
A: AsyncRead,
B: AsyncRead,
[src]
impl<A, B> AsyncRead for Either<A, B> where
A: AsyncRead,
B: AsyncRead,
[src]impl<A, B> AsyncWrite for Either<A, B> where
A: AsyncWrite,
B: AsyncWrite,
[src]
impl<A, B> AsyncWrite for Either<A, B> where
A: AsyncWrite,
B: AsyncWrite,
[src]fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
[src]
fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
[src]Attempt to write bytes from buf
into the object. Read more
fn poll_write_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>
[src]
fn poll_write_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>
[src]Attempt to write bytes from bufs
into the object using vectored
IO operations. Read more
impl<A: Clone, B: Clone> Clone for Either<A, B>
[src]
impl<A: Clone, B: Clone> Clone for Either<A, B>
[src]impl<A, B> FusedFuture for Either<A, B> where
A: FusedFuture,
B: FusedFuture<Output = A::Output>,
[src]
impl<A, B> FusedFuture for Either<A, B> where
A: FusedFuture,
B: FusedFuture<Output = A::Output>,
[src]fn is_terminated(&self) -> bool
[src]
fn is_terminated(&self) -> bool
[src]Returns true
if the underlying future should no longer be polled.
impl<A, B> FusedStream for Either<A, B> where
A: FusedStream,
B: FusedStream<Item = A::Item>,
[src]
impl<A, B> FusedStream for Either<A, B> where
A: FusedStream,
B: FusedStream<Item = A::Item>,
[src]fn is_terminated(&self) -> bool
[src]
fn is_terminated(&self) -> bool
[src]Returns true
if the stream should no longer be polled.
impl<A, B, Item> Sink<Item> for Either<A, B> where
A: Sink<Item>,
B: Sink<Item, Error = A::Error>,
[src]
impl<A, B, Item> Sink<Item> for Either<A, B> where
A: Sink<Item>,
B: Sink<Item, Error = A::Error>,
[src]fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]
fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]Attempts to prepare the Sink
to receive a value. Read more
fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::Error>
[src]
fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::Error>
[src]Begin the process of sending a value to the sink.
Each call to this function must be preceded by a successful call to
poll_ready
which returned Poll::Ready(Ok(()))
. Read more
impl<A, B> Stream for Either<A, B> where
A: Stream,
B: Stream<Item = A::Item>,
[src]
impl<A, B> Stream for Either<A, B> where
A: Stream,
B: Stream<Item = A::Item>,
[src]Auto Trait Implementations
impl<A, B> RefUnwindSafe for Either<A, B> where
A: RefUnwindSafe,
B: RefUnwindSafe,
A: RefUnwindSafe,
B: RefUnwindSafe,
impl<A, B> Send for Either<A, B> where
A: Send,
B: Send,
A: Send,
B: Send,
impl<A, B> Sync for Either<A, B> where
A: Sync,
B: Sync,
A: Sync,
B: Sync,
impl<A, B> Unpin for Either<A, B> where
A: Unpin,
B: Unpin,
A: Unpin,
B: Unpin,
impl<A, B> UnwindSafe for Either<A, B> where
A: UnwindSafe,
B: UnwindSafe,
A: UnwindSafe,
B: UnwindSafe,
Blanket Implementations
impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,
[src]
impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,
[src]fn fill_buf(&mut self) -> FillBuf<'_, Self>ⓘ where
Self: Unpin,
[src]
fn fill_buf(&mut self) -> FillBuf<'_, Self>ⓘ where
Self: Unpin,
[src]io
only.Creates a future which will wait for a non-empty buffer to be available from this I/O object or EOF to be reached. Read more
fn consume_unpin(&mut self, amt: usize) where
Self: Unpin,
[src]
fn consume_unpin(&mut self, amt: usize) where
Self: Unpin,
[src]io
only.A convenience for calling AsyncBufRead::consume
on Unpin
IO types. Read more
fn read_until<'a>(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ReadUntil<'a, Self>ⓘ where
Self: Unpin,
[src]
fn read_until<'a>(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ReadUntil<'a, Self>ⓘ where
Self: Unpin,
[src]io
only.Creates a future which will read all the bytes associated with this I/O
object into buf
until the delimiter byte
or EOF is reached.
This method is the async equivalent to BufRead::read_until
. Read more
fn read_line<'a>(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self>ⓘ where
Self: Unpin,
[src]
fn read_line<'a>(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self>ⓘ where
Self: Unpin,
[src]io
only.Creates a future which will read all the bytes associated with this I/O
object into buf
until a newline (the 0xA byte) or EOF is reached,
This method is the async equivalent to BufRead::read_line
. Read more
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
[src]
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
[src]fn chain<R>(self, next: R) -> Chain<Self, R> where
Self: Sized,
R: AsyncRead,
[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
Self: Sized,
R: AsyncRead,
[src]io
only.Creates an adaptor which will chain this stream with another. Read more
fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>ⓘ where
Self: Unpin,
[src]
fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>ⓘ where
Self: Unpin,
[src]io
only.Tries to read some bytes directly into the given buf
in asynchronous
manner, returning a future type. Read more
fn read_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>ⓘNotable traits for ReadVectored<'_, R>
impl<R: AsyncRead + ?Sized + Unpin> Future for ReadVectored<'_, R> type Output = Result<usize>;
where
Self: Unpin,
[src]
fn read_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>ⓘNotable traits for ReadVectored<'_, R>
impl<R: AsyncRead + ?Sized + Unpin> Future for ReadVectored<'_, R> type Output = Result<usize>;
where
Self: Unpin,
[src]io
only.Creates a future which will read from the AsyncRead
into bufs
using vectored
IO operations. Read more
fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>ⓘ where
Self: Unpin,
[src]
fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>ⓘ where
Self: Unpin,
[src]io
only.Creates a future which will read exactly enough bytes to fill buf
,
returning an error if end of file (EOF) is hit sooner. Read more
fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>ⓘ where
Self: Unpin,
[src]
fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>ⓘ where
Self: Unpin,
[src]io
only.Creates a future which will read all the bytes from this AsyncRead
. Read more
fn read_to_string<'a>(
&'a mut self,
buf: &'a mut String
) -> ReadToString<'a, Self>ⓘNotable traits for ReadToString<'_, A>
impl<A: ?Sized> Future for ReadToString<'_, A> where
A: AsyncRead + Unpin, type Output = Result<usize>;
where
Self: Unpin,
[src]
fn read_to_string<'a>(
&'a mut self,
buf: &'a mut String
) -> ReadToString<'a, Self>ⓘNotable traits for ReadToString<'_, A>
impl<A: ?Sized> Future for ReadToString<'_, A> where
A: AsyncRead + Unpin, type Output = Result<usize>;
where
Self: Unpin,
[src]io
only.Creates a future which will read all the bytes from this AsyncRead
. Read more
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite + Sized,
[src]
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite + Sized,
[src]io
only.Helper method for splitting this read/write object into two halves. Read more
fn take(self, limit: u64) -> Take<Self> where
Self: Sized,
[src]
fn take(self, limit: u64) -> Take<Self> where
Self: Sized,
[src]io
only.Creates an AsyncRead adapter which will read at most limit
bytes
from the underlying reader. Read more
fn compat(self) -> Compat<Self>ⓘNotable traits for Compat<R>
impl<R: AsyncRead03 + Unpin> Read for Compat<R>impl<W: AsyncWrite03 + Unpin> Write for Compat<W>
where
Self: Sized + Unpin,
[src]
fn compat(self) -> Compat<Self>ⓘNotable traits for Compat<R>
impl<R: AsyncRead03 + Unpin> Read for Compat<R>impl<W: AsyncWrite03 + Unpin> Write for Compat<W>
where
Self: Sized + Unpin,
[src]io
and io-compat
only.Wraps an AsyncRead
in a compatibility wrapper that allows it to be
used as a futures 0.1 / tokio-io 0.1 AsyncRead
. If the wrapped type
implements AsyncWrite
as well, the result will also implement the
futures 0.1 / tokio 0.1 AsyncWrite
trait. Read more
impl<S> AsyncSeekExt for S where
S: AsyncSeek + ?Sized,
[src]
impl<S> AsyncSeekExt for S where
S: AsyncSeek + ?Sized,
[src]fn seek(&mut self, pos: SeekFrom) -> Seek<'_, Self>ⓘ where
Self: Unpin,
[src]
fn seek(&mut self, pos: SeekFrom) -> Seek<'_, Self>ⓘ where
Self: Unpin,
[src]io
only.Creates a future which will seek an IO object, and then yield the new position in the object and the object itself. Read more
fn stream_position(&mut self) -> Seek<'_, Self>ⓘ where
Self: Unpin,
[src]
fn stream_position(&mut self) -> Seek<'_, Self>ⓘ where
Self: Unpin,
[src]io
only.Creates a future which will return the current seek position from the start of the stream. Read more
impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,
[src]
impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,
[src]fn flush(&mut self) -> Flush<'_, Self>ⓘ where
Self: Unpin,
[src]
fn flush(&mut self) -> Flush<'_, Self>ⓘ where
Self: Unpin,
[src]io
only.Creates a future which will entirely flush this AsyncWrite
. Read more
fn close(&mut self) -> Close<'_, Self>ⓘ where
Self: Unpin,
[src]
fn close(&mut self) -> Close<'_, Self>ⓘ where
Self: Unpin,
[src]io
only.Creates a future which will entirely close this AsyncWrite
.
fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>ⓘ where
Self: Unpin,
[src]
fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>ⓘ where
Self: Unpin,
[src]io
only.Creates a future which will write bytes from buf
into the object. Read more
fn write_vectored<'a>(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self>ⓘNotable traits for WriteVectored<'_, W>
impl<W: AsyncWrite + ?Sized + Unpin> Future for WriteVectored<'_, W> type Output = Result<usize>;
where
Self: Unpin,
[src]
fn write_vectored<'a>(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self>ⓘNotable traits for WriteVectored<'_, W>
impl<W: AsyncWrite + ?Sized + Unpin> Future for WriteVectored<'_, W> type Output = Result<usize>;
where
Self: Unpin,
[src]io
only.Creates a future which will write bytes from bufs
into the object using vectored
IO operations. Read more
fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self>ⓘ where
Self: Unpin,
[src]
fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self>ⓘ where
Self: Unpin,
[src]io
only.Write data into this object. Read more
fn write_all_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSlice<'a>]
) -> WriteAllVectored<'a, Self>ⓘNotable traits for WriteAllVectored<'_, W>
impl<W: AsyncWrite + ?Sized + Unpin> Future for WriteAllVectored<'_, W> type Output = Result<()>;
where
Self: Unpin,
[src]
fn write_all_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSlice<'a>]
) -> WriteAllVectored<'a, Self>ⓘNotable traits for WriteAllVectored<'_, W>
impl<W: AsyncWrite + ?Sized + Unpin> Future for WriteAllVectored<'_, W> type Output = Result<()>;
where
Self: Unpin,
[src]io
only.Attempts to write multiple buffers into this writer. Read more
fn compat_write(self) -> Compat<Self>ⓘNotable traits for Compat<R>
impl<R: AsyncRead03 + Unpin> Read for Compat<R>impl<W: AsyncWrite03 + Unpin> Write for Compat<W>
where
Self: Sized + Unpin,
[src]
fn compat_write(self) -> Compat<Self>ⓘNotable traits for Compat<R>
impl<R: AsyncRead03 + Unpin> Read for Compat<R>impl<W: AsyncWrite03 + Unpin> Write for Compat<W>
where
Self: Sized + Unpin,
[src]io
and io-compat
only.Wraps an AsyncWrite
in a compatibility wrapper that allows it to be
used as a futures 0.1 / tokio-io 0.1 AsyncWrite
.
Requires the io-compat
feature to enable. Read more
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<F> IntoFuture for F where
F: Future,
[src]
impl<F> IntoFuture for F where
F: Future,
[src]type Output = <F as Future>::Output
type Output = <F as Future>::Output
into_future
)The output that the future will produce on completion.
type Future = F
type Future = F
into_future
)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future
[src]
pub fn into_future(self) -> <F as IntoFuture>::Future
[src]into_future
)Creates a future from a value.
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
[src]
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
[src]fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,
Self: Sized,
[src]
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,
Self: Sized,
[src]sink
only.Composes a function in front of the sink. Read more
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,
Self: Sized,
[src]
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,
Self: Sized,
[src]sink
only.Composes a function in front of the sink. Read more
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Self: Sized,
[src]
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Self: Sized,
[src]sink
only.Transforms the error returned by the sink.
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self: Sized,
Self::Error: Into<E>,
[src]
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self: Sized,
Self::Error: Into<E>,
[src]sink
only.Map this sink’s error to a different error type using the Into
trait. Read more
fn buffer(self, capacity: usize) -> Buffer<Self, Item> where
Self: Sized,
[src]
fn buffer(self, capacity: usize) -> Buffer<Self, Item> where
Self: Sized,
[src]sink
only.Adds a fixed-size buffer to the current sink. Read more
fn close(&mut self) -> Close<'_, Self, Item>ⓘ where
Self: Unpin,
[src]
fn close(&mut self) -> Close<'_, Self, Item>ⓘ where
Self: Unpin,
[src]sink
only.Close the sink.
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Self: Sized,
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
[src]
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Self: Sized,
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
[src]sink
only.Fanout items to multiple sinks. Read more
fn flush(&mut self) -> Flush<'_, Self, Item>ⓘ where
Self: Unpin,
[src]
fn flush(&mut self) -> Flush<'_, Self, Item>ⓘ where
Self: Unpin,
[src]sink
only.Flush the sink, processing all pending items. Read more
fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘ where
Self: Unpin,
[src]
fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘ where
Self: Unpin,
[src]sink
only.A future that completes after the given item has been fully processed into the sink, including flushing. Read more
fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘ where
Self: Unpin,
[src]
fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘ where
Self: Unpin,
[src]sink
only.A future that completes after the given item has been received by the sink. Read more
fn send_all<'a, St: ?Sized>(
&'a mut self,
stream: &'a mut St
) -> SendAll<'a, Self, St>ⓘ where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin,
Self: Unpin,
[src]
fn send_all<'a, St: ?Sized>(
&'a mut self,
stream: &'a mut St
) -> SendAll<'a, Self, St>ⓘ where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin,
Self: Unpin,
[src]sink
only.A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘ where
Si2: Sink<Item, Error = Self::Error>,
Self: Sized,
[src]
fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘ where
Si2: Sink<Item, Error = Self::Error>,
Self: Sized,
[src]sink
only.Wrap this sink in an Either
sink, making it the left-hand variant
of that Either
. Read more
fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘ where
Si1: Sink<Item, Error = Self::Error>,
Self: Sized,
[src]
fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘ where
Si1: Sink<Item, Error = Self::Error>,
Self: Sized,
[src]sink
only.Wrap this stream in an Either
stream, making it the right-hand variant
of that Either
. Read more
fn compat(self) -> CompatSink<Self, Item> where
Self: Sized + Unpin,
[src]
fn compat(self) -> CompatSink<Self, Item> where
Self: Sized + Unpin,
[src]sink
and compat
only.fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]
fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]sink
only.A convenience method for calling Sink::poll_ready
on Unpin
sink types. Read more
fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
[src]
fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
[src]sink
only.A convenience method for calling Sink::start_send
on Unpin
sink types. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more