Struct tokio_boring::SslStream

pub struct SslStream<S>(_);

A wrapper around an underlying raw stream which implements the SSL protocol.

A SslStream<S> represents a handshake that has been completed successfully and both the server and the client are ready for receiving and sending data. Bytes read from a SslStream are decrypted from S and bytes written to a SslStream are encrypted when passing through to S.

Implementations

impl<S> 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.

impl<S> SslStream<S> where
    S: AsyncRead + AsyncWrite + Unpin, 

pub unsafe fn from_raw_parts(ssl: *mut SSL, stream: S) -> Self

Constructs an SslStream from a pointer to the underlying OpenSSL SSL struct.

This is useful if the handshake has already been completed elsewhere.

Safety

The caller must ensure the pointer is valid.

Trait Implementations

impl<S> AsyncRead for SslStream<S> where
    S: AsyncRead + AsyncWrite + Unpin, 

pub unsafe fn prepare_uninitialized_buffer(
    &self,
    _: &mut [MaybeUninit<u8>]
) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

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

Attempts to read from the AsyncRead into buf.

pub fn poll_read_buf<B>(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut B
) -> Poll<Result<usize, Error>> where
    B: BufMut, 

Pulls some bytes from this source into the specified BufMut, returning how many bytes were read.

impl<S> AsyncWrite for SslStream<S> where
    S: AsyncRead + AsyncWrite + Unpin, 

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

Attempt to write bytes from buf into the object.

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

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

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

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

pub fn poll_write_buf<B>(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut B
) -> Poll<Result<usize, Error>> where
    B: Buf, 

Writes a Buf into this value, returning how many bytes were written.

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

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

Formats the value using the given formatter.