Struct mio::Ready

pub struct Ready(_);

A set of readiness event kinds

Ready is a set of operation descriptors indicating which kind of an operation is ready to be performed. For example, Ready::readable() indicates that the associated Evented handle is ready to perform a read operation.

This struct only represents portable event kinds. Since only readable and writable events are guaranteed to be raised on all systems, those are the only ones available via the Ready struct. There are also platform specific extensions to Ready, i.e. UnixReady, which provide additional readiness event kinds only available on unix platforms.

Ready values can be combined together using the various bitwise operators.

For high level documentation on polling and readiness, see Poll.

Examples

use mio::Ready;

let ready = Ready::readable() | Ready::writable();

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

Methods

impl Ready

pub fn empty() -> Ready

Returns the empty Ready set.

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::empty();

assert!(!ready.is_readable());

pub fn readable() -> Ready

Returns a Ready representing readable readiness.

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::readable();

assert!(ready.is_readable());

pub fn writable() -> Ready

Returns a Ready representing writable readiness.

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::writable();

assert!(ready.is_writable());

pub fn all() -> Ready

Returns a Ready representing readiness for all operations.

This includes platform specific operations as well (hup, aio, error, lio, pri).

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::all();

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

pub fn is_empty(&self) -> bool

Returns true if Ready is the empty set

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::empty();
assert!(ready.is_empty());

pub fn is_readable(&self) -> bool

Returns true if the value includes readable readiness

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::readable();

assert!(ready.is_readable());

pub fn is_writable(&self) -> bool

Returns true if the value includes writable readiness

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::writable();

assert!(ready.is_writable());

pub fn insert<T: Into<Self>>(&mut self, other: T)

Adds all readiness represented by other into self.

This is equivalent to *self = *self | other.

Examples

use mio::Ready;

let mut readiness = Ready::empty();
readiness.insert(Ready::readable());

assert!(readiness.is_readable());

pub fn remove<T: Into<Self>>(&mut self, other: T)

Removes all options represented by other from self.

This is equivalent to *self = *self & !other.

Examples

use mio::Ready;

let mut readiness = Ready::readable();
readiness.remove(Ready::readable());

assert!(!readiness.is_readable());

pub fn contains<T: Into<Self>>(&self, other: T) -> bool

Returns true if self is a superset of other.

other may represent more than one readiness operations, in which case the function only returns true if self contains all readiness specified in other.

See Poll for more documentation on polling.

Examples

use mio::Ready;

let readiness = Ready::readable();

assert!(readiness.contains(Ready::readable()));
assert!(!readiness.contains(Ready::writable()));

use mio::Ready;

let readiness = Ready::readable() | Ready::writable();

assert!(readiness.contains(Ready::readable()));
assert!(readiness.contains(Ready::writable()));

use mio::Ready;

let readiness = Ready::readable() | Ready::writable();

assert!(!Ready::readable().contains(readiness));
assert!(readiness.contains(readiness));

pub fn from_usize(val: usize) -> Ready

Create a Ready instance using the given usize representation.

The usize representation must have been obtained from a call to Ready::as_usize.

The usize representation must be treated as opaque. There is no guaranteed correlation between the returned value and platform defined constants. Also, there is no guarantee that the usize representation will remain constant across patch releases of Mio.

This function is mainly provided to allow the caller to loa a readiness value from an AtomicUsize.

Examples

use mio::Ready;

let ready = Ready::readable();
let ready_usize = ready.as_usize();
let ready2 = Ready::from_usize(ready_usize);

assert_eq!(ready, ready2);

pub fn as_usize(&self) -> usize

Returns a usize representation of the Ready value.

This usize representation must be treated as opaque. There is no guaranteed correlation between the returned value and platform defined constants. Also, there is no guarantee that the usize representation will remain constant across patch releases of Mio.

This function is mainly provided to allow the caller to store a readiness value in an AtomicUsize.

Examples

use mio::Ready;

let ready = Ready::readable();
let ready_usize = ready.as_usize();
let ready2 = Ready::from_usize(ready_usize);

assert_eq!(ready, ready2);

Trait Implementations

impl Clone for Ready

fn clone(&self) -> Ready

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Ready

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl From<Ready> for UnixReady

fn from(src: Ready) -> UnixReady

Performs the conversion.

impl From<UnixReady> for Ready

fn from(src: UnixReady) -> Ready

Performs the conversion.

impl Copy for Ready

impl Eq for Ready

impl PartialOrd<Ready> for Ready

fn partial_cmp(&self, other: &Ready) -> Option<Ordering>

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

fn lt(&self, other: &Ready) -> bool

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

fn le(&self, other: &Ready) -> bool

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

fn gt(&self, other: &Ready) -> bool

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

fn ge(&self, other: &Ready) -> bool

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

impl PartialEq<Ready> for Ready

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

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

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

This method tests for !=.

impl Debug for Ready

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

Formats the value using the given formatter.

impl<T: Into<Ready>> Sub<T> for Ready

type Output = Ready

The resulting type after applying the - operator.

fn sub(self, other: T) -> Ready

Performs the - operation.

impl<T: Into<Ready>> SubAssign<T> for Ready

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl<T: Into<Ready>> BitAnd<T> for Ready

type Output = Ready

The resulting type after applying the & operator.

fn bitand(self, other: T) -> Ready

Performs the & operation.

impl<T: Into<Ready>> BitOr<T> for Ready

type Output = Ready

The resulting type after applying the | operator.

fn bitor(self, other: T) -> Ready

Performs the | operation.

impl<T: Into<Ready>> BitXor<T> for Ready

type Output = Ready

The resulting type after applying the ^ operator.

fn bitxor(self, other: T) -> Ready

Performs the ^ operation.

impl<T: Into<Ready>> BitAndAssign<T> for Ready

fn bitand_assign(&mut self, other: T)

Performs the &= operation.

impl<T: Into<Ready>> BitOrAssign<T> for Ready

fn bitor_assign(&mut self, other: T)

Performs the |= operation.

impl<T: Into<Ready>> BitXorAssign<T> for Ready

fn bitxor_assign(&mut self, other: T)

Performs the ^= operation.