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)

Tuple Fields of First

0: A

Second(B)

Tuple Fields of Second

0: B

Trait Implementations

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

pub fn poll_read(
    self: Pin<&mut EitherOutput<A, B>>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

pub fn poll_read_vectored(
    self: Pin<&mut EitherOutput<A, B>>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

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, 

pub fn poll_write(
    self: Pin<&mut EitherOutput<A, B>>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

pub fn poll_write_vectored(
    self: Pin<&mut EitherOutput<A, B>>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

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

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

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

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

Attempt to close the object.

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

pub 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, B> Debug for EitherOutput<A, B> where
    A: Debug,
    B: Debug, 

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

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 as Sink<I>>::Error, <B as Sink<I>>::Error>

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

pub fn poll_ready(
    self: Pin<&mut EitherOutput<A, B>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), <EitherOutput<A, B> as Sink<I>>::Error>>

Attempts to prepare the Sink to receive a value.

pub fn start_send(
    self: Pin<&mut EitherOutput<A, B>>,
    item: I
) -> Result<(), <EitherOutput<A, B> as Sink<I>>::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(())).

pub fn poll_flush(
    self: Pin<&mut EitherOutput<A, B>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), <EitherOutput<A, B> as Sink<I>>::Error>>

Flush any remaining output from this sink.

pub fn poll_close(
    self: Pin<&mut EitherOutput<A, B>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), <EitherOutput<A, B> as Sink<I>>::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 as TryStream>::Error, <B as TryStream>::Error>>

Values yielded by the stream.

pub fn poll_next(
    self: Pin<&mut EitherOutput<A, B>>,
    cx: &mut Context<'_>
) -> Poll<Option<<EitherOutput<A, B> as Stream>::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 as StreamMuxer>::Substream, <B as StreamMuxer>::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 = Error

Error type of the muxer

pub fn poll_event(
    &self,
    cx: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent<<EitherOutput<A, B> as StreamMuxer>::Substream>, <EitherOutput<A, B> as StreamMuxer>::Error>>

Polls for a connection-wide event.

pub fn open_outbound(
    &self
) -> <EitherOutput<A, B> as StreamMuxer>::OutboundSubstream

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

pub fn poll_outbound(
    &self,
    cx: &mut Context<'_>,
    substream: &mut <EitherOutput<A, B> as StreamMuxer>::OutboundSubstream
) -> Poll<Result<<EitherOutput<A, B> as StreamMuxer>::Substream, <EitherOutput<A, B> as StreamMuxer>::Error>>

Polls the outbound substream.

pub fn destroy_outbound(
    &self,
    substream: <EitherOutput<A, B> as StreamMuxer>::OutboundSubstream
)

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

pub fn read_substream(
    &self,
    cx: &mut Context<'_>,
    sub: &mut <EitherOutput<A, B> as StreamMuxer>::Substream,
    buf: &mut [u8]
) -> Poll<Result<usize, <EitherOutput<A, B> as StreamMuxer>::Error>>

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

pub fn write_substream(
    &self,
    cx: &mut Context<'_>,
    sub: &mut <EitherOutput<A, B> as StreamMuxer>::Substream,
    buf: &[u8]
) -> Poll<Result<usize, <EitherOutput<A, B> as StreamMuxer>::Error>>

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

pub fn flush_substream(
    &self,
    cx: &mut Context<'_>,
    sub: &mut <EitherOutput<A, B> as StreamMuxer>::Substream
) -> Poll<Result<(), <EitherOutput<A, B> as StreamMuxer>::Error>>

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

pub fn shutdown_substream(
    &self,
    cx: &mut Context<'_>,
    sub: &mut <EitherOutput<A, B> as StreamMuxer>::Substream
) -> Poll<Result<(), <EitherOutput<A, B> as StreamMuxer>::Error>>

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

pub fn destroy_substream(
    &self,
    substream: <EitherOutput<A, B> as StreamMuxer>::Substream
)

Destroys a substream.

pub fn close(
    &self,
    cx: &mut Context<'_>
) -> Poll<Result<(), <EitherOutput<A, B> as StreamMuxer>::Error>>

Closes this StreamMuxer.

pub fn flush_all(
    &self,
    cx: &mut Context<'_>
) -> Poll<Result<(), <EitherOutput<A, B> as StreamMuxer>::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, B> Copy for EitherOutput<A, B> where
    A: Copy,
    B: Copy, 

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