Struct Ready 

pub struct Ready(/* private fields */);

Available on crate feature net, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Describes the readiness state of an I/O resources.

Ready tracks which operation an I/O resource is ready to perform.

Implementations

impl Ready

pub const EMPTY: Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns the empty Ready set.

pub const READABLE: Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns a Ready representing readable readiness.

pub const WRITABLE: Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns a Ready representing writable readiness.

pub const READ_CLOSED: Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns a Ready representing read closed readiness.

pub const WRITE_CLOSED: Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns a Ready representing write closed readiness.

pub const PRIORITY: Ready

Available on Linux or Android only.

Returns a Ready representing priority readiness.

pub const ERROR: Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns a Ready representing error readiness.

pub const ALL: Ready

Available on (crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux) and (Linux or Android) only.

Returns a Ready representing readiness for all operations.

pub fn is_empty(self) -> bool

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns true if Ready is the empty set.

Examples

use tokio::io::Ready;

assert!(Ready::EMPTY.is_empty());
assert!(!Ready::READABLE.is_empty());

pub fn is_readable(self) -> bool

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns true if the value includes readable.

Examples

use tokio::io::Ready;

assert!(!Ready::EMPTY.is_readable());
assert!(Ready::READABLE.is_readable());
assert!(Ready::READ_CLOSED.is_readable());
assert!(!Ready::WRITABLE.is_readable());

pub fn is_writable(self) -> bool

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns true if the value includes writable readiness.

Examples

use tokio::io::Ready;

assert!(!Ready::EMPTY.is_writable());
assert!(!Ready::READABLE.is_writable());
assert!(Ready::WRITABLE.is_writable());
assert!(Ready::WRITE_CLOSED.is_writable());

pub fn is_read_closed(self) -> bool

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns true if the value includes read-closed readiness.

Examples

use tokio::io::Ready;

assert!(!Ready::EMPTY.is_read_closed());
assert!(!Ready::READABLE.is_read_closed());
assert!(Ready::READ_CLOSED.is_read_closed());

pub fn is_write_closed(self) -> bool

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns true if the value includes write-closed readiness.

Examples

use tokio::io::Ready;

assert!(!Ready::EMPTY.is_write_closed());
assert!(!Ready::WRITABLE.is_write_closed());
assert!(Ready::WRITE_CLOSED.is_write_closed());

pub fn is_priority(self) -> bool

Available on Linux or Android only.

Returns true if the value includes priority readiness.

Examples

use tokio::io::Ready;

assert!(!Ready::EMPTY.is_priority());
assert!(!Ready::WRITABLE.is_priority());
assert!(Ready::PRIORITY.is_priority());

pub fn is_error(self) -> bool

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

Returns true if the value includes error readiness.

Examples

use tokio::io::Ready;

assert!(!Ready::EMPTY.is_error());
assert!(!Ready::WRITABLE.is_error());
assert!(Ready::ERROR.is_error());

Trait Implementations

impl BitAnd for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

type Output = Ready

The resulting type after applying the & operator.

fn bitand(self, other: Ready) -> Ready

Performs the & operation.

impl BitOr for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

type Output = Ready

The resulting type after applying the | operator.

fn bitor(self, other: Ready) -> Ready

Performs the | operation.

impl BitOrAssign for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

fn bitor_assign(&mut self, other: Ready)

Performs the |= operation.

impl Clone for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

fn clone(&self) -> Ready

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

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

Formats the value using the given formatter.

impl Ord for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

fn cmp(&self, other: &Ready) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

fn eq(&self, other: &Ready) -> 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 PartialOrd for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

fn partial_cmp(&self, other: &Ready) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

type Output = Ready

The resulting type after applying the - operator.

fn sub(self, other: Ready) -> Ready

Performs the - operation.

impl Copy for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

impl Eq for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.

impl StructuralPartialEq for Ready

Available on crate feature net, or Unix and crate feature process, or Unix and crate feature signal, or tokio_unstable and crate feature io-uring and crate feature rt and crate feature fs and Linux only.