Struct SslStream 

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

Compio asynchronous version of openssl:ssl::SslStream.

Implementations

impl<S: AsyncRead + AsyncWrite> SslStream<S>

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

Create a new SslStream.

Reference: SslStream::new

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

Get a mutable reference to the underlying stream.

Warning

Any read/write operation to the stream would most likely corrupt the SSL session.

pub fn get_ref(&self) -> &S

Returns a shared reference to the underlying stream.

pub fn ssl(&self) -> &SslRef

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

pub async fn accept(&mut self) -> Result<()>

Initiates a server-side TLS handshake.

Reference: SslStream::accept

pub async fn connect(&mut self) -> Result<()>

Initiates a server-side TLS handshake.

Reference: SslStream::connect

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

Read application data transmitted by a client before handshake completion.

Useful for reducing latency, but vulnerable to replay attacks.

Returns Ok(0) if all early data has been read.

Reference: SslStream::read_early_data

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

Send data to the server without blocking on handshake completion.

Useful for reducing latency, but vulnerable to replay attacks.

Reference: SslStream::write_early_data

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

Reads data from the stream, without removing it from the queue.

Reference: SslStream::ssl_peek

pub fn get_shutdown(&mut self) -> ShutdownState

Returns the session’s shutdown state.

pub fn set_shutdown(&mut self, state: ShutdownState)

Sets the session’s shutdown state.

This can be used to tell OpenSSL that the session should be cached even if a full two-way shutdown was not completed.

pub async fn stateless(&mut self) -> Result<bool, ErrorStack>

Perform a stateless server-side handshake.

Requires that cookie generation and verification callbacks were set on the SSL context.

Returns Ok(true) if a complete ClientHello containing a valid cookie was read, in which case the handshake should be continued via accept. If a HelloRetryRequest containing a fresh cookie was transmitted, Ok(false) is returned instead. If the handshake cannot proceed at all, Err is returned.

Trait Implementations

impl<S: AsyncRead> AsyncRead for SslStream<S>

async fn read<B: IoBufMut>(&mut self, buf: B) -> BufResult<usize, B>

Read some bytes from this source into the IoBufMut buffer and return a BufResult, consisting of the buffer and a usize indicating how many bytes were read.

async fn read_vectored<V>(&mut self, buf: V) -> BufResult<usize, V>

where V: IoVectoredBufMut,

Like read, except that it reads into a type implements IoVectoredBufMut.

impl<S: AsyncWrite + AsyncRead> AsyncWrite for SslStream<S>

AsyncRead is needed for shutting down stream.

async fn write<T: IoBuf>(&mut self, buf: T) -> BufResult<usize, T>

Write some bytes from the buffer into this source and return a BufResult, consisting of the buffer and a usize indicating how many bytes were written.

async fn flush(&mut self) -> Result<()>

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

async fn shutdown(&mut self) -> Result<()>

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

async fn write_vectored<T>(&mut self, buf: T) -> BufResult<usize, T>

where T: IoVectoredBuf,

Like write, except that it write bytes from a buffer implements IoVectoredBuf into the source.

impl<S: Debug> Debug for SslStream<S>

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

Formats the value using the given formatter.

impl<S> From<SslStream<SyncStream<S>>> for SslStream<S>

fn from(value: SslStream<SyncStream<S>>) -> Self

Converts to this type from the input type.