Struct mio::Ready [] [src]

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

Returns the empty Ready set.

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::empty();

assert!(!ready.is_readable());

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

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

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

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

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

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

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

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));
assert!((readiness | Ready::hup()).contains(readiness));

Trait Implementations

impl Copy for Ready
[src]

impl PartialEq for Ready
[src]

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

This method tests for !=.

impl Eq for Ready
[src]

impl Clone for Ready
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl PartialOrd for Ready
[src]

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

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

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

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

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

impl Ord for Ready
[src]

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

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

Compares and returns the maximum of two values. Read more

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

Compares and returns the minimum of two values. Read more

impl<T: Into<Ready>> BitOr<T> for Ready
[src]

The resulting type after applying the | operator

The method for the | operator

impl<T: Into<Ready>> BitOrAssign<T> for Ready
[src]

The method for the |= operator

impl<T: Into<Ready>> BitXor<T> for Ready
[src]

The resulting type after applying the ^ operator

The method for the ^ operator

impl<T: Into<Ready>> BitXorAssign<T> for Ready
[src]

The method for the ^= operator

impl<T: Into<Ready>> BitAnd<T> for Ready
[src]

The resulting type after applying the & operator

The method for the & operator

impl<T: Into<Ready>> BitAndAssign<T> for Ready
[src]

The method for the &= operator

impl<T: Into<Ready>> Sub<T> for Ready
[src]

The resulting type after applying the - operator

The method for the - operator

impl<T: Into<Ready>> SubAssign<T> for Ready
[src]

The method for the -= operator

impl Not for Ready
[src]

The resulting type after applying the ! operator

The method for the unary ! operator

impl Debug for Ready
[src]

Formats the value using the given formatter.

impl From<UnixReady> for Ready
[src]

Performs the conversion.