Struct libp2p::yamux::Yamux [−][src]
pub struct Yamux<S>(_);
Expand description
A Yamux connection.
Trait Implementations
Note: This implementation never emits
StreamMuxerEvent::AddressChange
events.
type Substream = Stream
type Substream = Stream
Type of the object that represents the raw substream where data can be read and written.
Future that will be resolved when the outgoing substream is open.
type Error = YamuxError
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>>
[src]
pub fn poll_event(
&self,
c: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent<<Yamux<S> as StreamMuxer>::Substream>, YamuxError>>
[src]Polls for a connection-wide event. Read more
Opens a new outgoing substream, and produces the equivalent to a future that will be resolved when it becomes available. Read more
pub fn poll_outbound(
&self,
c: &mut Context<'_>,
&mut OpenSubstreamToken
) -> Poll<Result<<Yamux<S> as StreamMuxer>::Substream, YamuxError>>
[src]
pub fn poll_outbound(
&self,
c: &mut Context<'_>,
&mut OpenSubstreamToken
) -> Poll<Result<<Yamux<S> as StreamMuxer>::Substream, YamuxError>>
[src]Polls the outbound substream. Read more
Destroys an outbound substream future. Use this after the outbound substream has finished, or if you want to interrupt it. Read more
pub fn read_substream(
&self,
c: &mut Context<'_>,
s: &mut <Yamux<S> as StreamMuxer>::Substream,
b: &mut [u8]
) -> Poll<Result<usize, YamuxError>>
[src]
pub fn read_substream(
&self,
c: &mut Context<'_>,
s: &mut <Yamux<S> as StreamMuxer>::Substream,
b: &mut [u8]
) -> Poll<Result<usize, YamuxError>>
[src]Reads data from a substream. The behaviour is the same as futures::AsyncRead::poll_read
. Read more
pub fn write_substream(
&self,
c: &mut Context<'_>,
s: &mut <Yamux<S> as StreamMuxer>::Substream,
b: &[u8]
) -> Poll<Result<usize, YamuxError>>
[src]
pub fn write_substream(
&self,
c: &mut Context<'_>,
s: &mut <Yamux<S> as StreamMuxer>::Substream,
b: &[u8]
) -> Poll<Result<usize, YamuxError>>
[src]Write data to a substream. The behaviour is the same as futures::AsyncWrite::poll_write
. Read more
pub fn flush_substream(
&self,
c: &mut Context<'_>,
s: &mut <Yamux<S> as StreamMuxer>::Substream
) -> Poll<Result<(), YamuxError>>
[src]
pub fn flush_substream(
&self,
c: &mut Context<'_>,
s: &mut <Yamux<S> as StreamMuxer>::Substream
) -> Poll<Result<(), YamuxError>>
[src]Flushes a substream. The behaviour is the same as futures::AsyncWrite::poll_flush
. Read more
pub fn shutdown_substream(
&self,
c: &mut Context<'_>,
s: &mut <Yamux<S> as StreamMuxer>::Substream
) -> Poll<Result<(), YamuxError>>
[src]
pub fn shutdown_substream(
&self,
c: &mut Context<'_>,
s: &mut <Yamux<S> as StreamMuxer>::Substream
) -> Poll<Result<(), YamuxError>>
[src]Attempts to shut down the writing side of a substream. The behaviour is similar to
AsyncWrite::poll_close
. Read more
Destroys a substream.
Closes this StreamMuxer
. Read more
Flush this StreamMuxer
. Read more
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. Read more
Auto Trait Implementations
impl<S> !RefUnwindSafe for Yamux<S>
impl<S> !UnwindSafe for Yamux<S>