Struct SslStream 

pub struct SslStream<S: Unpin> { /* private fields */ }

An asynchronous version of openssl::ssl::SslStream.

Each write stages at most 16 KiB. If it returns Pending, that chunk remains queued for an OpenSSL retry. Cancelling the write future does not discard the staged chunk; the next TLS operation retries it first. The rest of the original input is not retained. This also applies to TLS 1.3 early-data writes. A cancelled AsyncWrite::poll_write followed by a new write from the same address and with the same length and staged prefix cannot be distinguished from polling the original write again. Use write_cancellable for distinct write operations, or flush the stream before reusing that buffer for a separate trait write.

Implementations

impl<S> SslStream<S>

where S: AsyncRead + AsyncWrite + Unpin,

pub fn new(ssl: Ssl, stream: S) -> Result<Self, ErrorStack>

Like SslStream::new.

pub async fn write_cancellable( self: Pin<&mut Self>, buf: &[u8], ) -> Result<usize>

Writes once, keeping this call distinct from later calls with the same buffer.

If this future is cancelled while a write is pending, a later write or flush finishes the queued bytes. A subsequent call to write_cancellable then sends a separate copy even if it uses the same buffer. The returned count may be less than buf.len().

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

Like SslStream::connect.

pub async fn connect(self: Pin<&mut Self>) -> Result<(), Error>

A convenience method wrapping poll_connect.

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

Like SslStream::accept.

pub async fn accept(self: Pin<&mut Self>) -> Result<(), Error>

A convenience method wrapping poll_accept.

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

Like SslStream::do_handshake.

pub async fn do_handshake(self: Pin<&mut Self>) -> Result<(), Error>

A convenience method wrapping poll_do_handshake.

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

Like SslStream::ssl_peek.

pub async fn peek(self: Pin<&mut Self>, buf: &mut [u8]) -> Result<usize, Error>

A convenience method wrapping poll_peek.

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

Like SslStream::read_early_data.

pub async fn read_early_data( self: Pin<&mut Self>, buf: &mut [u8], ) -> Result<usize, Error>

A convenience method wrapping poll_read_early_data.

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

Like SslStream::write_early_data.

If this returns Pending, the bytes are retained for a retry. Flush before using the same buffer for a separate write after cancellation, or use write_early_data to distinguish separate calls.

pub async fn write_early_data( self: Pin<&mut Self>, buf: &[u8], ) -> Result<usize, Error>

Writes TLS 1.3 early data as a distinct operation, including after cancellation.

If this future is cancelled while an early-data write is pending, a later write or flush finishes the queued bytes. A subsequent call sends a separate copy even if it uses the same buffer. The returned count may be less than buf.len().

impl<S: Unpin> SslStream<S>

pub fn ssl(&self) -> &SslRef

Returns a shared reference to the Ssl object associated with this stream.

pub fn get_ref(&self) -> &S

Returns a shared reference to the underlying stream.

pub fn get_mut(&mut self) -> &mut S

Returns a mutable reference to the underlying stream.

Warning

Reading from or writing to the underlying stream directly will corrupt the TLS session.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut S>

Returns a pinned mutable reference to the underlying stream.

Warning

Reading from or writing to the underlying stream directly will corrupt the TLS session.

Trait Implementations

impl<S> AsyncRead for SslStream<S>

where S: AsyncRead + AsyncWrite + Unpin,

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

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<S> AsyncWrite for SslStream<S>

where S: AsyncRead + AsyncWrite + Unpin,

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

Attempt to write bytes from buf into the object.

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

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

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

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<S> Debug for SslStream<S>

where S: Debug + Unpin,

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

Formats the value using the given formatter.