Struct multistream_select::Negotiated
source · pub struct Negotiated<TInner> { /* private fields */ }Expand description
An I/O stream that has settled on an (application-layer) protocol to use.
A Negotiated represents an I/O stream that has settled on a protocol
to use. In particular, it is not implied that all of the protocol negotiation
frames have yet been sent and / or received, just that the selected protocol
is fully determined. This is to allow the last protocol negotiation frames
sent by a peer to be combined in a single write, possibly piggy-backing
data from the negotiated protocol on top.
Reading from a Negotiated I/O stream that still has pending negotiation
protocol data to send implicitly triggers flushing of all yet unsent data.
Implementations§
source§impl<TInner> Negotiated<TInner>
impl<TInner> Negotiated<TInner>
sourcepub fn complete(self) -> NegotiatedComplete<TInner> ⓘ
pub fn complete(self) -> NegotiatedComplete<TInner> ⓘ
Returns a NegotiatedComplete future that waits for protocol
negotiation to complete.
Trait Implementations§
source§impl<TInner> AsyncRead for Negotiated<TInner>where
TInner: AsyncRead + AsyncWrite + Unpin,
impl<TInner> AsyncRead for Negotiated<TInner>where TInner: AsyncRead + AsyncWrite + Unpin,
source§impl<TInner> AsyncWrite for Negotiated<TInner>where
TInner: AsyncWrite + AsyncRead + Unpin,
impl<TInner> AsyncWrite for Negotiated<TInner>where TInner: AsyncWrite + AsyncRead + Unpin,
source§fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize, Error>>
fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8] ) -> Poll<Result<usize, Error>>
Attempt to write bytes from
buf into the object. Read moresource§fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Error>>
fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Error>>
Attempt to flush the object, ensuring that any buffered data reach
their destination. Read more
source§impl<TInner: Debug> Debug for Negotiated<TInner>
impl<TInner: Debug> Debug for Negotiated<TInner>
impl<'pin, TInner> Unpin for Negotiated<TInner>where __Negotiated<'pin, TInner>: Unpin,
Auto Trait Implementations§
impl<TInner> RefUnwindSafe for Negotiated<TInner>where TInner: RefUnwindSafe,
impl<TInner> Send for Negotiated<TInner>where TInner: Send,
impl<TInner> Sync for Negotiated<TInner>where TInner: Sync,
impl<TInner> UnwindSafe for Negotiated<TInner>where TInner: UnwindSafe,
Blanket Implementations§
source§impl<R> AsyncReadExt for Rwhere
R: AsyncRead + ?Sized,
impl<R> AsyncReadExt for Rwhere R: AsyncRead + ?Sized,
source§fn chain<R>(self, next: R) -> Chain<Self, R>where
Self: Sized,
R: AsyncRead,
fn chain<R>(self, next: R) -> Chain<Self, R>where Self: Sized, R: AsyncRead,
Creates an adaptor which will chain this stream with another. Read more
source§fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where
Self: Unpin,
fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where Self: Unpin,
Tries to read some bytes directly into the given
buf in asynchronous
manner, returning a future type. Read moresource§fn read_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>where
Self: Unpin,
fn read_vectored<'a>( &'a mut self, bufs: &'a mut [IoSliceMut<'a>] ) -> ReadVectored<'a, Self>where Self: Unpin,
Creates a future which will read from the
AsyncRead into bufs using vectored
IO operations. Read moresource§fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where
Self: Unpin,
fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where Self: Unpin,
Creates a future which will read exactly enough bytes to fill
buf,
returning an error if end of file (EOF) is hit sooner. Read moresource§fn read_to_end<'a>(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEnd<'a, Self>where
Self: Unpin,
fn read_to_end<'a>( &'a mut self, buf: &'a mut Vec<u8, Global> ) -> ReadToEnd<'a, Self>where Self: Unpin,
Creates a future which will read all the bytes from this
AsyncRead. Read moresource§fn read_to_string<'a>(
&'a mut self,
buf: &'a mut String
) -> ReadToString<'a, Self>where
Self: Unpin,
fn read_to_string<'a>( &'a mut self, buf: &'a mut String ) -> ReadToString<'a, Self>where Self: Unpin,
Creates a future which will read all the bytes from this
AsyncRead. Read moresource§impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,
impl<W> AsyncWriteExt for Wwhere W: AsyncWrite + ?Sized,
source§fn flush(&mut self) -> Flush<'_, Self>where
Self: Unpin,
fn flush(&mut self) -> Flush<'_, Self>where Self: Unpin,
Creates a future which will entirely flush this
AsyncWrite. Read moresource§fn close(&mut self) -> Close<'_, Self>where
Self: Unpin,
fn close(&mut self) -> Close<'_, Self>where Self: Unpin,
Creates a future which will entirely close this
AsyncWrite.source§fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where
Self: Unpin,
fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where Self: Unpin,
Creates a future which will write bytes from
buf into the object. Read moresource§fn write_vectored<'a>(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self>where
Self: Unpin,
fn write_vectored<'a>( &'a mut self, bufs: &'a [IoSlice<'a>] ) -> WriteVectored<'a, Self>where Self: Unpin,
Creates a future which will write bytes from
bufs into the object using vectored
IO operations. Read moresource§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more