Struct libp2p::yamux::Yamux

pub struct Yamux<S>(_);

A Yamux connection.

Trait Implementations

impl<S> Debug for Yamux<S>

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

Formats the value using the given formatter.

impl<S> StreamMuxer for Yamux<S> where
    S: Stream<Item = Result<Stream, YamuxError>> + Unpin, 

Note: This implementation never emits StreamMuxerEvent::AddressChange events.

type Substream = Stream

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

type OutboundSubstream = OpenSubstreamToken

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

type Error = YamuxError

Error type of the muxer

pub fn poll_event(
    &self,
    c: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent<<Yamux<S> as StreamMuxer>::Substream>, YamuxError>>

Polls for a connection-wide event.

pub fn open_outbound(&self) -> <Yamux<S> 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,
    c: &mut Context<'_>,
    &mut OpenSubstreamToken
) -> Poll<Result<<Yamux<S> as StreamMuxer>::Substream, YamuxError>>

Polls the outbound substream.

pub fn destroy_outbound(&self, <Yamux<S> 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,
    c: &mut Context<'_>,
    s: &mut <Yamux<S> as StreamMuxer>::Substream,
    b: &mut [u8]
) -> Poll<Result<usize, YamuxError>>

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

pub fn write_substream(
    &self,
    c: &mut Context<'_>,
    s: &mut <Yamux<S> as StreamMuxer>::Substream,
    b: &[u8]
) -> Poll<Result<usize, YamuxError>>

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

pub fn flush_substream(
    &self,
    c: &mut Context<'_>,
    s: &mut <Yamux<S> as StreamMuxer>::Substream
) -> Poll<Result<(), YamuxError>>

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

pub fn shutdown_substream(
    &self,
    c: &mut Context<'_>,
    s: &mut <Yamux<S> as StreamMuxer>::Substream
) -> Poll<Result<(), YamuxError>>

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

pub fn destroy_substream(&self, <Yamux<S> as StreamMuxer>::Substream)

Destroys a substream.

pub fn close(&self, c: &mut Context<'_>) -> Poll<Result<(), YamuxError>>

Closes this StreamMuxer.

pub fn flush_all(&self, &mut Context<'_>) -> Poll<Result<(), YamuxError>>

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.