# [−] [src] Struct mio::Interest

    pub struct Interest(_);

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

### `impl Interest` [src]

#### `pub const READABLE: Interest` [src]

Returns a `Interest` set representing readable interests.

#### `pub const WRITABLE: Interest` [src]

Returns a `Interest` set representing writable interests.

#### `pub const fn add(self, other: Interest) -> Interest` [src]

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>` [src]

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` [src]

Returns true if the value includes readable readiness.

#### `pub const fn is_writable(self) -> bool` [src]

Returns true if the value includes writable readiness.

#### `pub const fn is_aio(self) -> bool` [src]

Returns true if `Interest` contains AIO readiness

#### `pub const fn is_lio(self) -> bool` [src]

Returns true if `Interest` contains LIO readiness

## Trait Implementations

### `impl BitOr<Interest> for Interest` [src]

#### `type Output = Self`

The resulting type after applying the `|` operator.

#### `fn bitor(self, other: Self) -> Self` [src]

Performs the `|` operation. Read more

### `impl BitOrAssign<Interest> for Interest` [src]

#### `fn bitor_assign(&mut self, other: Self)` [src]

Performs the `|=` operation. Read more

### `impl Clone for Interest` [src]

#### `fn clone(&self) -> Interest` [src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl Copy for Interest` [src]

### `impl Debug for Interest` [src]

#### `fn fmt(&self, fmt: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl Eq for Interest` [src]

### `impl Ord for Interest` [src]

#### `fn cmp(&self, other: &Interest) -> Ordering` [src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `#[must_use]fn max(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the maximum of two values. Read more

#### `#[must_use]fn min(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the minimum of two values. Read more

#### `#[must_use]fn clamp(self, min: Self, max: Self) -> Self` [src]

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

Restrict a value to a certain interval. Read more

### `impl PartialEq<Interest> for Interest` [src]

#### `fn eq(&self, other: &Interest) -> bool` [src]

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

#### `fn ne(&self, other: &Interest) -> bool` [src]

This method tests for `!=`.

### `impl PartialOrd<Interest> for Interest` [src]

#### `fn partial_cmp(&self, other: &Interest) -> Option<Ordering>` [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

#### `fn lt(&self, other: &Interest) -> bool` [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `fn le(&self, other: &Interest) -> bool` [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `fn gt(&self, other: &Interest) -> bool` [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

#### `fn ge(&self, other: &Interest) -> bool` [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

### `impl StructuralEq for Interest` [src]

### `impl StructuralPartialEq for Interest` [src]

## Auto Trait Implementations

### `impl RefUnwindSafe for Interest`

### `impl Send for Interest`

### `impl Sync for Interest`

### `impl Unpin for Interest`

### `impl UnwindSafe for Interest`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

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

#### `pub fn clone_into(&self, target: &mut T)` [src]

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

recently added

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

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.