Struct libp2p_yamux::Yamux
source · [−]pub struct Yamux<S> { /* private fields */ }Expand description
A Yamux connection.
Trait Implementations
sourceimpl<S> StreamMuxer for Yamux<S>where
S: Stream<Item = Result<Stream, YamuxError>> + Unpin,
impl<S> StreamMuxer for Yamux<S>where
S: Stream<Item = Result<Stream, YamuxError>> + Unpin,
type Substream = Stream
type Substream = Stream
Type of the object that represents the raw substream where data can be read and written.
type Error = YamuxError
type Error = YamuxError
Error type of the muxer
sourcefn poll_inbound(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>
fn poll_inbound(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>
Poll for new inbound substreams. Read more
sourcefn poll_outbound(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>
fn poll_outbound(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>
Poll for a new, outbound substream.
sourcefn poll(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent, Self::Error>>
fn poll(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent, Self::Error>>
Poll to allow the underlying connection to make progress. Read more
sourcefn poll_close(self: Pin<&mut Self>, c: &mut Context<'_>) -> Poll<YamuxResult<()>>
fn poll_close(self: Pin<&mut Self>, c: &mut Context<'_>) -> Poll<YamuxResult<()>>
Poll to close this
StreamMuxer. Read moreAuto Trait Implementations
impl<S> !RefUnwindSafe for Yamux<S>
impl<S> Send for Yamux<S>where
S: Send,
impl<S> Sync for Yamux<S>where
S: Sync,
impl<S> Unpin for Yamux<S>where
S: Unpin,
impl<S> !UnwindSafe for Yamux<S>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<S> StreamMuxerExt for Swhere
S: StreamMuxer,
impl<S> StreamMuxerExt for Swhere
S: StreamMuxer,
sourcefn poll_inbound_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>where
Self: Unpin,
fn poll_inbound_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>where
Self: Unpin,
sourcefn poll_outbound_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>where
Self: Unpin,
fn poll_outbound_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>where
Self: Unpin,
sourcefn poll_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent, Self::Error>>where
Self: Unpin,
fn poll_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent, Self::Error>>where
Self: Unpin,
sourcefn poll_close_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
Self: Unpin,
fn poll_close_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
Self: Unpin,
sourcefn next_inbound(&mut self) -> NextInbound<'_, Self>
fn next_inbound(&mut self) -> NextInbound<'_, Self>
👎Deprecated since 0.37.0: This future violates the
StreamMuxer contract because it doesn’t call StreamMuxer::poll.Returns a future that resolves to the next inbound
Substream opened by the remote.sourcefn next_outbound(&mut self) -> NextOutbound<'_, Self>
fn next_outbound(&mut self) -> NextOutbound<'_, Self>
👎Deprecated since 0.37.0: This future violates the
StreamMuxer contract because it doesn’t call StreamMuxer::poll.Returns a future that opens a new outbound
Substream with the remote.sourcefn close(self) -> Close<Self>
fn close(self) -> Close<Self>
Returns a future for closing this
StreamMuxer.