Struct async_native_tls::TlsStream

pub struct TlsStream<S>(_);

A stream managing a TLS session.

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.

Methods

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.

pub fn buffered_read_size(&self) -> Result<usize> where
    S: AsyncRead + AsyncWrite + Unpin, 

Returns the number of bytes that can be read without resulting in any network calls.

pub fn peer_certificate(&self) -> Result<Option<Certificate>> where
    S: AsyncRead + AsyncWrite + Unpin, 

Returns the peer's leaf certificate, if available.

pub fn tls_server_end_point(&self) -> Result<Option<Vec<u8>>> where
    S: AsyncRead + AsyncWrite + Unpin, 

Returns the tls-server-end-point channel binding data as defined in RFC 5929.

Trait Implementations

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

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

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

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

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

Attempt to write bytes from buf into the object.

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

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

fn poll_close(self: Pin<&mut Self>, ctx: &mut Context) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<S: Debug> Debug for TlsStream<S>

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

Formats the value using the given formatter.