Struct native_tls::TlsStream

[+] Show declaration

pub struct TlsStream<S>(_);

[−] Expand description

A stream managing a TLS session.

Implementations

impl<S> TlsStream<S>[−]

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.

impl<S: Read + Write> TlsStream<S>[−]

pub fn buffered_read_size(&self) -> Result<usize>[−]

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

pub fn peer_certificate(&self) -> Result<Option<Certificate>>[−]

Returns the peer’s leaf certificate, if available.

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

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

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

Shuts down the TLS session.

Trait Implementations

impl<S: Debug> Debug for TlsStream<S>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<S: Read + Write> Read for TlsStream<S>[+]

[+] Show hidden undocumented items

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.

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

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

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

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

pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>[−]

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

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

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

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

Read the exact number of bytes required to fill buf.

pub fn by_ref(&mut self) -> &mut Self[−]

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

pub fn bytes(self) -> Bytes<Self>[−]

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

pub fn take(self, limit: u64) -> Take<Self>[−]

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

impl<S: Read + Write> Write for TlsStream<S>[+]

[+] Show hidden undocumented items

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

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

fn flush(&mut self) -> Result<()>[−]

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

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

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

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

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

Attempts to write an entire buffer into this writer.

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

pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>[−]

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

pub fn by_ref(&mut self) -> &mut Self[−]

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