Struct tokio::io::ready::Ready

source ·
pub struct Ready(usize);
Expand description

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§

source§

impl Ready

source

pub const EMPTY: Ready = _

Returns the empty Ready set.

source

pub const READABLE: Ready = _

Returns a Ready representing readable readiness.

source

pub const WRITABLE: Ready = _

Returns a Ready representing writable readiness.

source

pub const READ_CLOSED: Ready = _

Returns a Ready representing read closed readiness.

source

pub const WRITE_CLOSED: Ready = _

Returns a Ready representing write closed readiness.

source

pub const PRIORITY: Ready = _

Returns a Ready representing priority readiness.

source

pub const ERROR: Ready = _

Returns a Ready representing error readiness.

source

pub const ALL: Ready = _

Returns a Ready representing readiness for all operations.

source

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

source

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

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

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

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

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

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

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

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.

source

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.

source

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.

source

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

source

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

source

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

Trait Implementations§

source§

impl BitAnd for Ready

§

type Output = Ready

The resulting type after applying the & operator.
source§

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

Performs the & operation. Read more
source§

impl BitOr for Ready

§

type Output = Ready

The resulting type after applying the | operator.
source§

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

Performs the | operation. Read more
source§

impl BitOrAssign for Ready

source§

fn bitor_assign(&mut self, other: Ready)

Performs the |= operation. Read more
source§

impl Clone for Ready

source§

fn clone(&self) -> Ready

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Ready

source§

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

Formats the value using the given formatter. Read more
source§

impl Ord for Ready

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Ready

source§

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

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

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.
source§

impl PartialOrd for Ready

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Sub for Ready

§

type Output = Ready

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl Copy for Ready

source§

impl Eq for Ready

source§

impl StructuralPartialEq for Ready

Auto Trait Implementations§

§

impl Freeze for Ready

§

impl RefUnwindSafe for Ready

§

impl Send for Ready

§

impl Sync for Ready

§

impl Unpin for Ready

§

impl UnwindSafe for Ready

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.