Struct tokio::io::Interest

pub struct Interest(_);

Readiness event interest.

Specifies the readiness events the caller is interested in when awaiting on I/O resource readiness states.

Implementations

impl Interest

pub const READABLE: Interest

Interest in all readable events.

Readable interest includes read-closed events.

pub const WRITABLE: Interest

Interest in all writable events.

Writable interest includes write-closed events.

pub const fn is_readable(self) -> bool

Returns true if the value includes readable interest.

Examples

use tokio::io::Interest;

assert!(Interest::READABLE.is_readable());
assert!(!Interest::WRITABLE.is_readable());

let both = Interest::READABLE | Interest::WRITABLE;
assert!(both.is_readable());

pub const fn is_writable(self) -> bool

Returns true if the value includes writable interest.

Examples

use tokio::io::Interest;

assert!(!Interest::READABLE.is_writable());
assert!(Interest::WRITABLE.is_writable());

let both = Interest::READABLE | Interest::WRITABLE;
assert!(both.is_writable());

pub const fn add(self, other: Interest) -> Interest

Add together two Interest values.

This function works from a const context.

Examples

use tokio::io::Interest;

const BOTH: Interest = Interest::READABLE.add(Interest::WRITABLE);

assert!(BOTH.is_readable());
assert!(BOTH.is_writable());

Trait Implementations

impl BitOr<Interest> for Interest

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<Interest> for Interest

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl Clone for Interest

fn clone(&self) -> Interest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Interest

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

Formats the value using the given formatter.

impl PartialEq<Interest> for Interest

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

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

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

This method tests for !=.

impl Copy for Interest

impl Eq for Interest

impl StructuralEq for Interest

impl StructuralPartialEq for Interest