Struct actix_tls::accept::openssl::TlsStream

pub struct TlsStream<IO>(_);

This is supported on crate features accept and openssl only.

Wraps an openssl based async TLS stream in order to implement [ActixStream].

Methods from Deref<Target = SslStream<IO>>

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

This is supported on crate feature connect only.

Like SslStream::connect.

pub async fn connect(self: Pin<&'_ mut SslStream<S>>) -> Result<(), Error>

This is supported on crate feature connect only.

A convenience method wrapping poll_connect.

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

This is supported on crate feature connect only.

Like SslStream::accept.

pub async fn accept(self: Pin<&'_ mut SslStream<S>>) -> Result<(), Error>

This is supported on crate feature connect only.

A convenience method wrapping poll_accept.

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

This is supported on crate feature connect only.

Like SslStream::do_handshake.

pub async fn do_handshake(self: Pin<&'_ mut SslStream<S>>) -> Result<(), Error>

This is supported on crate feature connect only.

A convenience method wrapping poll_do_handshake.

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

This is supported on crate feature connect only.

Like SslStream::read_early_data.

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

This is supported on crate feature connect only.

A convenience method wrapping poll_read_early_data.

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

This is supported on crate feature connect only.

Like SslStream::write_early_data.

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

This is supported on crate feature connect only.

A convenience method wrapping poll_write_early_data.

pub fn ssl(&self) -> &SslRef

This is supported on crate feature connect only.

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

pub fn get_ref(&self) -> &S

This is supported on crate feature connect only.

Returns a shared reference to the underlying stream.

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

This is supported on crate feature connect only.

Returns a mutable reference to the underlying stream.

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

This is supported on crate feature connect only.

Returns a pinned mutable reference to the underlying stream.

Trait Implementations

impl<IO: ActixStream> AsyncRead for TlsStream<IO>

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: ActixStream> AsyncWrite for TlsStream<IO>

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>>

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.

impl<IO> Deref for TlsStream<IO>

type Target = SslStream<IO>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<IO> DerefMut for TlsStream<IO>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<IO> From<SslStream<IO>> for TlsStream<IO>

fn from(original: SslStream<IO>) -> TlsStream<IO>

Performs the conversion.