Struct mio::unix::UnixReady [−] [src]

pub struct UnixReady(_);

Unix specific extensions to Ready

Provides additional readiness event kinds that are available on unix platforms. Unix platforms are able to provide readiness events for additional socket events, such as HUP and error.

HUP events occur when the remote end of a socket hangs up. In the TCP case, this occurs when the remote end of a TCP socket shuts down writes.

Error events occur when the socket enters an error state. In this case, the socket will also receive a readable or writable event. Reading or writing to the socket will result in an error.

Conversion traits are implemented between Ready and UnixReady. See the examples.

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

Examples

Most of the time, all that is needed is using bit operations

use mio::Ready;
use mio::unix::UnixReady;

let ready = Ready::readable() | UnixReady::hup();

assert!(ready.is_readable());
assert!(UnixReady::from(ready).is_hup());

Basic conversion between ready types.

use mio::Ready;
use mio::unix::UnixReady;

// Start with a portable ready
let ready = Ready::readable();

// Convert to a unix ready, adding HUP
let mut unix_ready = UnixReady::from(ready) | UnixReady::hup();

unix_ready.insert(UnixReady::error());

// `unix_ready` maintains readable interest
assert!(unix_ready.is_readable());
assert!(unix_ready.is_hup());
assert!(unix_ready.is_error());

// Convert back to `Ready`
let ready = Ready::from(unix_ready);

// Readable is maintained
assert!(ready.is_readable());

Registering readable and error interest on a socket

use mio::{Ready, Poll, PollOpt, Token};
use mio::tcp::TcpStream;
use mio::unix::UnixReady;

let addr = "216.58.193.68:80".parse().unwrap();
let socket = TcpStream::connect(&addr).unwrap();

let poll = Poll::new().unwrap();

poll.register(&socket,
              Token(0),
              Ready::readable() | UnixReady::error(),
              PollOpt::edge()).unwrap();

Methods

impl UnixReady
[src]

Returns a Ready representing AIO completion readiness

See Poll for more documentation on polling.

Examples

use mio::unix::UnixReady;

let ready = UnixReady::aio();

assert!(ready.is_aio());

Returns a Ready representing error readiness.

Note that only readable and writable readiness is guaranteed to be supported on all platforms. This means that error readiness should be treated as a hint. For more details, see readiness in the poll documentation.

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::error();

assert!(ready.is_error());

Returns a Ready representing HUP readiness.

A HUP (or hang-up) signifies that a stream socket peer closed the connection, or shut down the writing half of the connection.

Note that only readable and writable readiness is guaranteed to be supported on all platforms. This means that hup readiness should be treated as a hint. For more details, see readiness in the poll documentation.

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::hup();

assert!(ready.is_hup());

Returns true if Ready contains AIO readiness

See [Poll] for more documentation on polling.

Examples

use mio::unix::UnixReady;

let ready = UnixReady::aio();

assert!(ready.is_aio());

Returns true if the value includes error readiness

Note that only readable and writable readiness is guaranteed to be supported on all platforms. This means that error readiness should be treated as a hint. For more details, see [readiness] in the poll documentation.

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::error();

assert!(ready.is_error());

Returns true if the value includes HUP readiness

A HUP (or hang-up) signifies that a stream socket peer closed the connection, or shut down the writing half of the connection.

Note that only readable and writable readiness is guaranteed to be supported on all platforms. This means that hup readiness should be treated as a hint. For more details, see [readiness] in the poll documentation.

See Poll for more documentation on polling.

Examples

use mio::Ready;

let ready = Ready::hup();

assert!(ready.is_hup());

Methods from Deref<Target = Ready>

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 Debug for UnixReady
[src]

Formats the value using the given formatter.

impl Copy for UnixReady
[src]

impl PartialEq for UnixReady
[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 UnixReady
[src]

impl Clone for UnixReady
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl PartialOrd for UnixReady
[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 UnixReady
[src]

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

impl From<Ready> for UnixReady
[src]

Performs the conversion.

impl Deref for UnixReady
[src]

The resulting type after dereferencing

The method called to dereference a value

impl DerefMut for UnixReady
[src]

The method called to mutably dereference a value

impl BitOr for UnixReady
[src]

The resulting type after applying the | operator

The method for the | operator

impl BitXor for UnixReady
[src]

The resulting type after applying the ^ operator

The method for the ^ operator

impl BitAnd for UnixReady
[src]

The resulting type after applying the & operator

The method for the & operator

impl Sub for UnixReady
[src]

The resulting type after applying the - operator

The method for the - operator

impl Not for UnixReady
[src]

The resulting type after applying the ! operator

The method for the unary ! operator