Enum Readiness 

pub enum Readiness {
    Ready,
    Close,
    Terminate,
}

Filter readiness state.

Variants

Ready

The I/O task may proceed with I/O operations.

Close

The transport must be closed gracefully.

The I/O task must close both directions of the connection and then release it. For a socket this is shutdown(SHUT_RDWR) followed by close(). Any operation still in flight should be canceled.

During a graceful shutdown buffered output is drained before this is reported. If the connection ended because of a failure or an expired shutdown deadline, output may instead be undeliverable and discarded. In every case the I/O task must not attempt another flush.

Terminate

The transport must be released immediately.

This is reported only for an explicit force close through IoRef::terminate, so whatever is still buffered is discarded on purpose. The I/O task must not perform a graceful close: no receive queue drain and no shutdown(SHUT_RDWR), just release the connection. That keeps an aborted stream distinguishable from one that ended normally, instead of terminating a truncated response with a clean FIN.

A connection that ends because of an I/O failure, a filter failure or an expired shutdown deadline reports Close instead: the transport is gone or unusable, so there is nothing to gain from aborting it.

Implementations

impl Readiness

pub fn merge(val1: Poll<Readiness>, val2: Poll<Readiness>) -> Poll<Readiness>

Merges two readiness states without regard to argument order.

Terminate overrides every other state, Close overrides Pending and Ready, and Pending overrides Ready.

Trait Implementations

impl Clone for Readiness

fn clone(&self) -> Readiness

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Readiness

impl Debug for Readiness

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

Formats the value using the given formatter.

impl Eq for Readiness

impl Hash for Readiness

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Readiness

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Readiness