Struct IoState

pub struct IoState { /* private fields */ }

Values of this structure are returned from Connection::process_new_packets and tell the caller the current I/O state of the TLS connection.

Implementations

impl IoState

pub fn tls_bytes_to_write(&self) -> usize

How many bytes could be written by Connection::write_tls if called right now. A non-zero value implies CommonState::wants_write.

pub fn plaintext_bytes_to_read(&self) -> usize

How many plaintext bytes could be obtained via std::io::Read without further I/O.

pub fn peer_has_closed(&self) -> bool

True if the peer has sent us a close_notify alert. This is the TLS mechanism to securely half-close a TLS connection, and signifies that the peer will not send any further data on this connection.

This is also signalled via returning Ok(0) from std::io::Read, after all the received bytes have been retrieved.

Trait Implementations

impl Debug for IoState

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

Formats the value using the given formatter.

impl PartialEq for IoState

fn eq(&self, other: &IoState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for IoState

impl StructuralPartialEq for IoState

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes