Struct mio::Interest

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

Interest used in registering.

Interest are used in registering event::Sources with Poll, they indicate what readiness should be monitored for. For example if a socket is registered with readable interests and the socket becomes writable, no event will be returned from a call to poll.

Implementations

impl Interest

pub const READABLE: Interest = _

Returns a Interest set representing readable interests.

pub const WRITABLE: Interest = _

Returns a Interest set representing writable interests.

pub const PRIORITY: Interest = _

Returns a Interest set representing priority completion interests.

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

Add together two Interest.

This does the same thing as the BitOr implementation, but is a constant function.

use mio::Interest;

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

pub fn remove(self, other: Interest) -> Option<Interest>

Removes other Interest from self.

Returns None if the set would be empty after removing other.

use mio::Interest;

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

// As long a one interest remain this will return `Some`.
let w_interest = RW_INTERESTS.remove(Interest::READABLE).unwrap();
assert!(!w_interest.is_readable());
assert!(w_interest.is_writable());

// Removing all interests from the set will return `None`.
assert_eq!(w_interest.remove(Interest::WRITABLE), None);

// Its also possible to remove multiple interests at once.
assert_eq!(RW_INTERESTS.remove(RW_INTERESTS), None);

pub const fn is_readable(self) -> bool

Returns true if the value includes readable readiness.

pub const fn is_writable(self) -> bool

Returns true if the value includes writable readiness.

pub const fn is_aio(self) -> bool

Returns true if Interest contains AIO readiness.

pub const fn is_lio(self) -> bool

Returns true if Interest contains LIO readiness.

pub const fn is_priority(self) -> bool

Returns true if Interest contains priority readiness.

Trait Implementations

impl BitOr for Interest

type Output = Interest

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign 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 Ord for Interest

fn cmp(&self, other: &Interest) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Interest

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

fn partial_cmp(&self, other: &Interest) -> 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 Copy for Interest

impl Eq for Interest

impl StructuralPartialEq for Interest