Struct tls_api::TlsStreamWithSocket

[+] Show declaration

pub struct TlsStreamWithSocket<S: AsyncSocket>(_);

[−] Expand description

TLS stream object returned by connect_with_socket and accept_with_socket operations.

Since Rust has no HKT, it is not possible to declare something like

trait TlsConnector {
    type <S> TlsStream<S> : TlsStreamImpl;
}

So TlsStream is actually a box to concrete TLS implementation. So each operation perform a virtual call (which is not a big deal for sockets).

This type is parameterized by socket type, TlsStream is simpler version of this stream.

Implementations

impl<S: AsyncSocket> TlsStreamWithSocket<S>[−]

pub fn new<I: TlsStreamWithUpcastDyn<S>>(imp: I) -> TlsStreamWithSocket<S>[−]

Construct a stream from a stream implementation.

This function is intended to be used by API implementors, not by users.

pub fn without_type_parameter(self) -> TlsStream[−]

Convert to a functionally and performance identical TLS stream object but without socket type parameter.

Trait Implementations

impl<S: AsyncSocket> AsyncRead for TlsStreamWithSocket<S>[+]

[+] Show hidden undocumented items

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

Attempts to read from the AsyncRead into buf.

impl<S: AsyncSocket> AsyncWrite for TlsStreamWithSocket<S>[+]

[+] Show hidden undocumented items

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

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>,
    ctx: &mut Context<'_>
) -> Poll<Result<()>>[−]

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

impl<S: AsyncSocket> Debug for TlsStreamWithSocket<S>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<S: AsyncSocket> Deref for TlsStreamWithSocket<S>[+]

[+] Show hidden undocumented items

type Target = dyn TlsStreamWithUpcastDyn<S>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target[−]

Dereferences the value.

impl<S: AsyncSocket> DerefMut for TlsStreamWithSocket<S>[+]

[+] Show hidden undocumented items

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

Mutably dereferences the value.

impl<S: AsyncSocket> TlsStreamDyn for TlsStreamWithSocket<S>[+]

[+] Show hidden undocumented items

fn get_alpn_protocol(&self) -> Result<Option<Vec<u8>>>[−]

Get negotiated ALPN protocol negotiated.

fn impl_info(&self) -> ImplInfo[−]

Implementation info for this stream (e. g. which crate provides it).

fn get_socket_dyn_mut(&mut self) -> &mut dyn AsyncSocket[−]

Get the underlying socket.

fn get_socket_dyn_ref(&self) -> &dyn AsyncSocket[−]

Get the underlying socket.

impl<S: AsyncSocket> TlsStreamWithSocketDyn<S> for TlsStreamWithSocket<S>[+]

fn get_socket_mut(&mut self) -> &mut S[−]

Get a reference the underlying TLS-wrapped socket.

fn get_socket_ref(&self) -> &S[−]

Get a reference the underlying TLS-wrapped socket.