Struct TlsStream

pub struct TlsStream<S> { /* private fields */ }

An Schannel TLS stream.

Implementations

impl<S> TlsStream<S>

pub fn get_ref(&self) -> &S

Returns a reference to the wrapped stream.

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

Returns a mutable reference to the wrapped stream.

pub fn is_server(&self) -> bool

Indicates if this stream is the server- or client-side of a TLS session.

impl<S> TlsStream<S>

where S: Read + Write,

pub fn certificate(&self) -> Result<CertContext>

Returns the certificate used to identify this side of the TLS session.

Its associated cert store contains any intermediate certificates sent along with the leaf.

pub fn peer_certificate(&self) -> Result<CertContext>

Returns the peer’s certificate, if available.

Its associated cert store contains any intermediate certificates sent by the server.

pub fn negotiated_application_protocol(&self) -> Result<Option<Vec<u8>>>

Returns the negotiated application protocol for this tls stream, if one exists

pub fn session_resumed(&self) -> Result<bool>

Returns whether or not the session was resumed.

pub fn get_buf(&self) -> &[u8]

Returns a reference to the buffer of pending data.

Like BufRead::fill_buf except that it will return an empty slice rather than reading from the wrapped stream if there is no buffered data.

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

Shuts the TLS session down.

Trait Implementations

impl<S> BufRead for TlsStream<S>

where S: Read + Write,

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

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

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

Checks if the underlying Read has any data left to be read.

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

Reads all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

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

Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl<S> Debug for TlsStream<S>

where S: Debug,

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

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>

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.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

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

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

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

Creates an adapter 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>

In the case of a WouldBlock error, we expect another call starting with the same input data This is similar to the use of ACCEPT_MOVING_WRITE_BUFFER in openssl

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

Flushes 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 is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers 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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.