Struct mio::Interest

source ·
pub struct Interest(/* private fields */);
Expand description

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§

source§

impl Interest

source

pub const READABLE: Interest = _

Returns a Interest set representing readable interests.

source

pub const WRITABLE: Interest = _

Returns a Interest set representing writable interests.

source

pub const PRIORITY: Interest = _

Returns a Interest set representing priority completion interests.

source

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

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

pub const fn is_readable(self) -> bool

Returns true if the value includes readable readiness.

source

pub const fn is_writable(self) -> bool

Returns true if the value includes writable readiness.

source

pub const fn is_aio(self) -> bool

Returns true if Interest contains AIO readiness.

source

pub const fn is_lio(self) -> bool

Returns true if Interest contains LIO readiness.

source

pub const fn is_priority(self) -> bool

Returns true if Interest contains priority readiness.

Trait Implementations§

source§

impl BitOr<Interest> for Interest

§

type Output = Interest

The resulting type after applying the | operator.
source§

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

Performs the | operation. Read more
source§

impl BitOrAssign<Interest> for Interest

source§

fn bitor_assign(&mut self, other: Self)

Performs the |= operation. Read more
source§

impl Clone for Interest

source§

fn clone(&self) -> Interest

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 Interest

source§

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

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

impl Ord for Interest

source§

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

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

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

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

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

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

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

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

impl PartialEq<Interest> for Interest

source§

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

source§

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

source§

impl Eq for Interest

source§

impl StructuralEq for Interest

source§

impl StructuralPartialEq for Interest

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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 Twhere 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.