pub struct SingletonMuxer<TSocket> { /* private fields */ }
Expand description
Implementation of StreamMuxer
that allows only one substream on top of a connection,
yielding the connection itself.
Applying this muxer on a connection doesn’t read or write any data on the connection itself. Most notably, no protocol is negotiated.
Implementations
sourceimpl<TSocket> SingletonMuxer<TSocket>
impl<TSocket> SingletonMuxer<TSocket>
sourcepub fn new(inner: TSocket, endpoint: Endpoint) -> SingletonMuxer<TSocket>
pub fn new(inner: TSocket, endpoint: Endpoint) -> SingletonMuxer<TSocket>
Creates a new SingletonMuxer
.
If endpoint
is Dialer
, then only one outbound substream will be permitted.
If endpoint
is Listener
, then only one inbound substream will be permitted.
Trait Implementations
sourceimpl<TSocket> StreamMuxer for SingletonMuxer<TSocket> where
TSocket: AsyncRead + AsyncWrite + Unpin,
impl<TSocket> StreamMuxer for SingletonMuxer<TSocket> where
TSocket: AsyncRead + AsyncWrite + Unpin,
type Substream = Substream
type Substream = Substream
Type of the object that represents the raw substream where data can be read and written.
type OutboundSubstream = OutboundSubstream
type OutboundSubstream = OutboundSubstream
Future that will be resolved when the outgoing substream is open.
sourcepub fn poll_event(
&self,
&mut Context<'_>
) -> Poll<Result<StreamMuxerEvent<<SingletonMuxer<TSocket> as StreamMuxer>::Substream>, Error>>
pub fn poll_event(
&self,
&mut Context<'_>
) -> Poll<Result<StreamMuxerEvent<<SingletonMuxer<TSocket> as StreamMuxer>::Substream>, Error>>
Polls for a connection-wide event. Read more
sourcepub fn open_outbound(
&self
) -> <SingletonMuxer<TSocket> as StreamMuxer>::OutboundSubstream
pub fn open_outbound(
&self
) -> <SingletonMuxer<TSocket> as StreamMuxer>::OutboundSubstream
Opens a new outgoing substream, and produces the equivalent to a future that will be resolved when it becomes available. Read more
sourcepub fn poll_outbound(
&self,
&mut Context<'_>,
&mut <SingletonMuxer<TSocket> as StreamMuxer>::OutboundSubstream
) -> Poll<Result<<SingletonMuxer<TSocket> as StreamMuxer>::Substream, Error>>
pub fn poll_outbound(
&self,
&mut Context<'_>,
&mut <SingletonMuxer<TSocket> as StreamMuxer>::OutboundSubstream
) -> Poll<Result<<SingletonMuxer<TSocket> as StreamMuxer>::Substream, Error>>
Polls the outbound substream. Read more
sourcepub fn destroy_outbound(
&self,
<SingletonMuxer<TSocket> as StreamMuxer>::OutboundSubstream
)
pub fn destroy_outbound(
&self,
<SingletonMuxer<TSocket> as StreamMuxer>::OutboundSubstream
)
Destroys an outbound substream future. Use this after the outbound substream has finished, or if you want to interrupt it. Read more
sourcepub fn read_substream(
&self,
cx: &mut Context<'_>,
&mut <SingletonMuxer<TSocket> as StreamMuxer>::Substream,
buf: &mut [u8]
) -> Poll<Result<usize, Error>>
pub fn read_substream(
&self,
cx: &mut Context<'_>,
&mut <SingletonMuxer<TSocket> as StreamMuxer>::Substream,
buf: &mut [u8]
) -> Poll<Result<usize, Error>>
Reads data from a substream. The behaviour is the same as futures::AsyncRead::poll_read
. Read more
sourcepub fn write_substream(
&self,
cx: &mut Context<'_>,
&mut <SingletonMuxer<TSocket> as StreamMuxer>::Substream,
buf: &[u8]
) -> Poll<Result<usize, Error>>
pub fn write_substream(
&self,
cx: &mut Context<'_>,
&mut <SingletonMuxer<TSocket> as StreamMuxer>::Substream,
buf: &[u8]
) -> Poll<Result<usize, Error>>
Write data to a substream. The behaviour is the same as futures::AsyncWrite::poll_write
. Read more
sourcepub fn flush_substream(
&self,
cx: &mut Context<'_>,
&mut <SingletonMuxer<TSocket> as StreamMuxer>::Substream
) -> Poll<Result<(), Error>>
pub fn flush_substream(
&self,
cx: &mut Context<'_>,
&mut <SingletonMuxer<TSocket> as StreamMuxer>::Substream
) -> Poll<Result<(), Error>>
Flushes a substream. The behaviour is the same as futures::AsyncWrite::poll_flush
. Read more
sourcepub fn shutdown_substream(
&self,
cx: &mut Context<'_>,
&mut <SingletonMuxer<TSocket> as StreamMuxer>::Substream
) -> Poll<Result<(), Error>>
pub fn shutdown_substream(
&self,
cx: &mut Context<'_>,
&mut <SingletonMuxer<TSocket> as StreamMuxer>::Substream
) -> Poll<Result<(), Error>>
Attempts to shut down the writing side of a substream. The behaviour is similar to
AsyncWrite::poll_close
. Read more
sourcepub fn destroy_substream(
&self,
<SingletonMuxer<TSocket> as StreamMuxer>::Substream
)
pub fn destroy_substream(
&self,
<SingletonMuxer<TSocket> as StreamMuxer>::Substream
)
Destroys a substream.
sourcepub fn close(&self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>
pub fn close(&self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>
Closes this StreamMuxer
. Read more
sourcepub fn flush_all(&self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>
pub fn flush_all(&self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>
Flush this StreamMuxer
. Read more
sourcefn is_remote_acknowledged(&self) -> bool
fn is_remote_acknowledged(&self) -> bool
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<TSocket> !RefUnwindSafe for SingletonMuxer<TSocket>
impl<TSocket> Send for SingletonMuxer<TSocket> where
TSocket: Send,
impl<TSocket> Sync for SingletonMuxer<TSocket> where
TSocket: Send,
impl<TSocket> Unpin for SingletonMuxer<TSocket> where
TSocket: Unpin,
impl<TSocket> UnwindSafe for SingletonMuxer<TSocket> where
TSocket: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more