Struct rustls::Reader

pub struct Reader<'a> { /* private fields */ }

A structure that implements std::io::Read for reading plaintext.

Trait Implementations

impl<'a> Read for Reader<'a>

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

Obtain plaintext data received from the peer over this TLS connection.

If the peer closes the TLS session cleanly, this returns Ok(0) once all the pending data has been read. No further data can be received on that connection, so the underlying TCP connection should be half-closed too.

If the peer closes the TLS session uncleanly (a TCP EOF without sending a close_notify alert) this function returns Err(ErrorKind::UnexpectedEof.into()) once any pending data has been read.

Note that support for close_notify varies in peer TLS libraries: many do not support it and uncleanly close the TCP connection (this might be vulnerable to truncation attacks depending on the application protocol). This means applications using rustls must both handle EOF from this function, and unexpected EOF of the underlying TCP connection.

If there are no bytes to read, this returns Err(ErrorKind::WouldBlock.into()).

You may learn the number of bytes available at any time by inspecting the return of Connection::process_new_packets.

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

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

Obtain plaintext data received from the peer over this TLS connection.

If the peer closes the TLS session, this returns Ok(()) without filling any more of the buffer once all the pending data has been read. No further data can be received on that connection, so the underlying TCP connection should be half-closed too.

If the peer closes the TLS session uncleanly (a TCP EOF without sending a close_notify alert) this function returns Err(ErrorKind::UnexpectedEof.into()) once any pending data has been read.

Note that support for close_notify varies in peer TLS libraries: many do not support it and uncleanly close the TCP connection (this might be vulnerable to truncation attacks depending on the application protocol). This means applications using rustls must both handle EOF from this function, and unexpected EOF of the underlying TCP connection.

If there are no bytes to read, this returns Err(ErrorKind::WouldBlock.into()).

You may learn the number of bytes available at any time by inspecting the return of Connection::process_new_packets.

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, Global>) -> 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 read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Read the exact number of bytes required to fill cursor.

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 adapter which will chain this stream with another.

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

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