Struct multistream_select::Negotiated

pub struct Negotiated<TInner> { /* private fields */ }

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

impl<TInner> Negotiated<TInner>

pub fn complete(self) -> NegotiatedComplete<TInner>

Returns a NegotiatedComplete future that waits for protocol negotiation to complete.

Trait Implementations

impl<TInner> AsyncRead for Negotiated<TInner>where
    TInner: AsyncRead + AsyncWrite + Unpin,

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<TInner> AsyncWrite for Negotiated<TInner>where
    TInner: AsyncWrite + AsyncRead + Unpin,

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.

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.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<TInner: Debug> Debug for Negotiated<TInner>

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

Formats the value using the given formatter.

impl<'pin, TInner> Unpin for Negotiated<TInner>where
    __Negotiated<'pin, TInner>: Unpin,