Struct tokio::io::Ready

source · [−]

pub struct Ready(_);

Expand description

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 = Ready(0)

Returns the empty Ready set.

pub const READABLE: Ready = Ready(READABLE)

Returns a Ready representing readable readiness.

pub const WRITABLE: Ready = Ready(WRITABLE)

Returns a Ready representing writable readiness.

pub const READ_CLOSED: Ready = Ready(READ_CLOSED)

Returns a Ready representing read closed readiness.

pub const WRITE_CLOSED: Ready = Ready(WRITE_CLOSED)

Returns a Ready representing write closed readiness.

pub const ALL: Ready = Ready(READABLE | WRITABLE | READ_CLOSED | WRITE_CLOSED)

Returns a Ready representing readiness for all operations.

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

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. Read more

impl BitOr<Ready> for Ready

type Output = Ready

The resulting type after applying the | operator.

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

Performs the | operation. Read more

impl BitOrAssign<Ready> for Ready

fn bitor_assign(&mut self, other: Ready)

Performs the |= operation. Read more

impl Clone for Ready

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

impl Debug for Ready

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

Formats the value using the given formatter. Read more

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 ==. Read more

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

This method tests for !=.

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

impl Sub<Ready> for Ready

type Output = Ready

The resulting type after applying the - operator.

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

Performs the - operation. Read more

impl Copy for Ready

impl StructuralPartialEq for Ready

Auto Trait Implementations

impl RefUnwindSafe for Ready

impl Send for Ready

impl Sync for Ready

impl Unpin for Ready

impl UnwindSafe for Ready

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.