Struct tokio::io::ready::Ready

pub struct Ready(usize);

Describes the readiness state of an I/O resources.

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

Tuple Fields

0: usize

Implementations

impl Ready

pub const EMPTY: Ready = _

Returns the empty Ready set.

pub const READABLE: Ready = _

Returns a Ready representing readable readiness.

pub const WRITABLE: Ready = _

Returns a Ready representing writable readiness.

pub const READ_CLOSED: Ready = _

Returns a Ready representing read closed readiness.

pub const WRITE_CLOSED: Ready = _

Returns a Ready representing write closed readiness.

pub const PRIORITY: Ready = _

Returns a Ready representing priority readiness.

pub const ERROR: Ready = _

Returns a Ready representing error readiness.

pub const ALL: Ready = _

Returns a Ready representing readiness for all operations.

pub(crate) fn from_mio(event: &Event) -> Ready

pub fn is_empty(self) -> bool

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

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

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

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

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

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

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());

pub(crate) fn contains<T: Into<Self>>(self, other: T) -> bool

Returns true if self is a superset of other.

other may represent more than one readiness operations, in which case the function only returns true if self contains all readiness specified in other.

pub(crate) fn from_usize(val: usize) -> Ready

Creates a Ready instance using the given usize representation.

The usize representation must have been obtained from a call to Readiness::as_usize.

This function is mainly provided to allow the caller to get a readiness value from an AtomicUsize.

pub(crate) fn as_usize(self) -> usize

Returns a usize representation of the Ready value.

This function is mainly provided to allow the caller to store a readiness value in an AtomicUsize.

pub(crate) fn from_interest(interest: Interest) -> Ready

pub(crate) fn intersection(self, interest: Interest) -> Ready

pub(crate) fn satisfies(self, interest: Interest) -> bool

Trait Implementations

impl BitAnd<Ready> for Ready

type Output = Ready

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr<Ready> for Ready

type Output = Ready

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<Ready> for Ready

fn bitor_assign(&mut self, other: Ready)

Performs the |= operation.

impl Clone for Ready

fn clone(&self) -> Ready

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ready

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

Formats the value using the given formatter.

impl Ord for Ready

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Ready> for Ready

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<Ready> for Ready

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<Ready> for Ready

type Output = Ready

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Ready

impl Eq for Ready

impl StructuralEq for Ready

impl StructuralPartialEq for Ready