Struct websocket::sync::stream::TlsStream

pub struct TlsStream<S>(_);

A stream managing a TLS session.

Methods

impl<S> TlsStream<S> where
    S: Read + Write, 

pub fn get_ref(&self) -> &S

Returns a shared reference to the inner stream.

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

Returns a mutable reference to the inner stream.

pub fn buffered_read_size(&self) -> Result<usize, Error>

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

pub fn peer_certificate(&self) -> Result<Option<Certificate>, Error>

Returns the peer's leaf certificate, if available.

pub fn tls_server_end_point(&self) -> Result<Option<Vec<u8>>, Error>

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

pub fn shutdown(&mut self) -> Result<(), Error>

Shuts down the TLS session.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<S> Read for TlsStream<S> where
    S: Read + Write, 

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl<S> Write for TlsStream<S> where
    S: Read + Write, 

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<(), Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl AsTcpStream for TlsStream<TcpStream>

Important traits for TcpStream

impl Write for TcpStreamimpl<'_> Write for &'_ TcpStreamimpl Read for TcpStreamimpl<'_> Read for &'_ TcpStream

fn as_tcp(&self) -> &TcpStream

Get a borrow of the TcpStream