Struct ktls::CorkStream

pub struct CorkStream<IO> {
    pub io: IO,
    pub corked: bool,
    /* private fields */
}

This is a wrapper that reads TLS message headers so it knows when to start doing empty reads at the message boundary when “draining” a rustls connection before setting up kTLS for it.

The short explanation is: rustls might have buffered one or more ApplicationData messages (the last one might even be partial) by the time “connect” / “accept” returns.

We not only need to pop messages rustls has already deframed (that’s done in a drain function elsewhere), but also let rustls finish reading and deframing any partial message it may have already buffered.

Because this wrapper is trying very hard not to do any error handling, if it encounters anything that doesn’t look like a TLS header (unknown type, nonsensical size, unexpected EOF), it’ll quite easily fall back to a “passthrough” mode with no internal buffering, letting rustls take care reporting any errors.

Fields

io: IO

corked: bool

Implementations

impl<IO> CorkStream<IO>

pub fn new(io: IO) -> Self

Trait Implementations

impl<IO> AsyncRead for CorkStream<IO>where IO: AsyncRead,

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_> ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl<IO> AsyncWrite for CorkStream<IO>where IO: AsyncWrite,

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

Attempt to write bytes from buf into the object.

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

Attempts to flush the object, ensuring that any buffered data reach their destination.

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.