## Interest

# Struct Interest

Source

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

Expand description

Interest used in registering.

Interest are used in registering `event::Source`s 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 for Interest

Source§

#### 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 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 duplicate 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) -> 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,

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

### impl PartialEq for Interest

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

### impl PartialOrd 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

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

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

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

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 StructuralPartialEq for Interest

## Auto Trait Implementations§

§

### impl Freeze for Interest

§

### impl RefUnwindSafe for Interest

§

### impl Send for Interest

§

### impl Sync for Interest

§

### impl Unpin for Interest

§

### impl UnwindSafe for Interest

## 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> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. 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,

Source§

#### 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>,

Source§

#### 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>,

Source§

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