Struct libp2p::yamux::Yamux

pub struct Yamux<S> { /* private fields */ }

Available on crate feature yamux only.

A Yamux connection.

Trait Implementations

impl<S> Debug for Yamux<S>

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,

type Substream = Stream

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

type Error = YamuxError

Error type of the muxer

fn poll_inbound(
    self: Pin<&mut Yamux<S>>,
    cx: &mut Context<'_>
) -> Poll<Result<<Yamux<S> as StreamMuxer>::Substream, <Yamux<S> as StreamMuxer>::Error>>

Poll for new inbound substreams.

fn poll_outbound(
    self: Pin<&mut Yamux<S>>,
    cx: &mut Context<'_>
) -> Poll<Result<<Yamux<S> as StreamMuxer>::Substream, <Yamux<S> as StreamMuxer>::Error>>

Poll for a new, outbound substream.

fn poll(
    self: Pin<&mut Yamux<S>>,
    cx: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent, <Yamux<S> as StreamMuxer>::Error>>

Poll to allow the underlying connection to make progress.

fn poll_close(
    self: Pin<&mut Yamux<S>>,
    c: &mut Context<'_>
) -> Poll<Result<(), YamuxError>>

Poll to close this StreamMuxer.