Struct libp2p_yamux::Yamux

pub struct Yamux<S>(_);

A Yamux connection.

Trait Implementations

impl<S> Debug for Yamux<S>

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

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

fn poll_event(
    &self,
    c: &mut Context<'_>
) -> Poll<YamuxResult<StreamMuxerEvent<Self::Substream>>>

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,
    c: &mut Context<'_>,
    _: &mut OpenSubstreamToken
) -> Poll<YamuxResult<Self::Substream>>

Polls the outbound substream.

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

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

fn poll_close(&self, c: &mut Context<'_>) -> Poll<YamuxResult<()>>

Closes this StreamMuxer.