Struct hyper_tls::TlsStream

pub struct TlsStream<S>(_);

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

A TlsStream<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 TlsStream are decrypted from S and bytes written to a TlsStream are encrypted when passing through to S.

Implementations

impl<S> TlsStream<S>

pub fn get_ref(&self) -> &S where
    S: AsyncRead + AsyncWrite + Unpin, 

Returns a shared reference to the inner stream.

pub fn get_mut(&mut self) -> &mut S where
    S: AsyncRead + AsyncWrite + Unpin, 

Returns a mutable reference to the inner stream.

Trait Implementations

impl<S> AsyncRead for TlsStream<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 TlsStream<S>>,
    ctx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

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 TlsStream<S> where
    S: AsyncRead + AsyncWrite + Unpin, 

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

Attempt to write bytes from buf into the object.

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

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

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

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 for TlsStream<S> where
    S: Debug, 

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

Formats the value using the given formatter.

impl<T> From<TlsStream<T>> for MaybeHttpsStream<T>

fn from(inner: TlsStream<T>) -> Self

Performs the conversion.