Enum libp2p_core::either::EitherOutput

pub enum EitherOutput<A, B> {
    First(A),
    Second(B),
}

Implements AsyncRead and AsyncWrite and dispatches all method calls to either First or Second.

Variants

First(A)

Second(B)

Trait Implementations

impl<A, B> AsyncRead for EitherOutput<A, B> where
    A: AsyncRead,
    B: AsyncRead, 

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, IoError>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, IoError>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<A, B> AsyncWrite for EitherOutput<A, B> where
    A: AsyncWrite,
    B: AsyncWrite, 

fn poll_write(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize, IoError>>

Attempt to write bytes from buf into the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, IoError>>

Attempt to write bytes from bufs into the object using vectored IO operations.

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), IoError>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), IoError>>

Attempt to close the object.

impl<A: Clone, B: Clone> Clone for EitherOutput<A, B>

fn clone(&self) -> EitherOutput<A, B>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<A: Debug, B: Debug> Debug for EitherOutput<A, B>

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

Formats the value using the given formatter.

impl<A, B, I> Sink<I> for EitherOutput<A, B> where
    A: Sink<I>,
    B: Sink<I>, 

type Error = EitherError<A::Error, B::Error>

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>

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(())).

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<A, B, I> Stream for EitherOutput<A, B> where
    A: TryStream<Ok = I>,
    B: TryStream<Ok = I>, 

type Item = Result<I, EitherError<A::Error, B::Error>>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<A, B> StreamMuxer for EitherOutput<A, B> where
    A: StreamMuxer,
    B: StreamMuxer, 

type Substream = EitherOutput<A::Substream, B::Substream>

Type of the object that represents the raw substream where data can be read and written.

type OutboundSubstream = EitherOutbound<A, B>

Future that will be resolved when the outgoing substream is open.

type Error = IoError

Error type of the muxer

fn poll_event(
    &self,
    cx: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent<Self::Substream>, Self::Error>>

Polls for a connection-wide event.

fn open_outbound(&self) -> Self::OutboundSubstream

Opens a new outgoing substream, and produces the equivalent to a future that will be resolved when it becomes available.

fn poll_outbound(
    &self,
    cx: &mut Context<'_>,
    substream: &mut Self::OutboundSubstream
) -> Poll<Result<Self::Substream, Self::Error>>

Polls the outbound substream.

fn destroy_outbound(&self, substream: Self::OutboundSubstream)

Destroys an outbound substream future. Use this after the outbound substream has finished, or if you want to interrupt it.

fn read_substream(
    &self,
    cx: &mut Context<'_>,
    sub: &mut Self::Substream,
    buf: &mut [u8]
) -> Poll<Result<usize, Self::Error>>

Reads data from a substream. The behaviour is the same as futures::AsyncRead::poll_read.

fn write_substream(
    &self,
    cx: &mut Context<'_>,
    sub: &mut Self::Substream,
    buf: &[u8]
) -> Poll<Result<usize, Self::Error>>

Write data to a substream. The behaviour is the same as futures::AsyncWrite::poll_write.

fn flush_substream(
    &self,
    cx: &mut Context<'_>,
    sub: &mut Self::Substream
) -> Poll<Result<(), Self::Error>>

Flushes a substream. The behaviour is the same as futures::AsyncWrite::poll_flush.

fn shutdown_substream(
    &self,
    cx: &mut Context<'_>,
    sub: &mut Self::Substream
) -> Poll<Result<(), Self::Error>>

Attempts to shut down the writing side of a substream. The behaviour is similar to AsyncWrite::poll_close.

fn destroy_substream(&self, substream: Self::Substream)

Destroys a substream.

fn close(&self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Closes this StreamMuxer.

fn flush_all(&self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Flush this StreamMuxer.

fn is_remote_acknowledged(&self) -> bool

👎 Deprecated:

This method is unused and will be removed in the future

Returns true if the remote has shown any sign of activity after the muxer has been open.

impl<A: Copy, B: Copy> Copy for EitherOutput<A, B>

impl<'pin, A, B> Unpin for EitherOutput<A, B> where
    __EitherOutput<'pin, A, B>: Unpin,