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
.
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;
let ready = Ready::readable();
let mut unix_ready = UnixReady::from(ready) | UnixReady::hup();
unix_ready.insert(UnixReady::error());
assert!(unix_ready.is_readable());
assert!(unix_ready.is_hup());
assert!(unix_ready.is_error());
let ready = Ready::from(unix_ready);
assert!(ready.is_readable());
Registering readable and error interest on a socket
use mio::{Ready, Poll, PollOpt, Token};
use mio::net::TcpStream;
use mio::unix::UnixReady;
let addr = "216.58.193.68:80".parse()?;
let socket = TcpStream::connect(&addr)?;
let poll = Poll::new()?;
poll.register(&socket,
Token(0),
Ready::readable() | UnixReady::error(),
PollOpt::edge())?;
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.
use mio::unix::UnixReady;
let ready = UnixReady::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.
use mio::unix::UnixReady;
let ready = UnixReady::hup();
assert!(ready.is_hup());
Returns a Ready
representing priority (EPOLLPRI
) readiness
See Poll
for more documentation on polling.
use mio::unix::UnixReady;
let ready = UnixReady::priority();
assert!(ready.is_priority());
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.
use mio::unix::UnixReady;
let ready = UnixReady::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.
use mio::unix::UnixReady;
let ready = UnixReady::hup();
assert!(ready.is_hup());
Returns true if Ready
contains priority (EPOLLPRI
) readiness
See Poll
for more documentation on polling.
use mio::unix::UnixReady;
let ready = UnixReady::priority();
assert!(ready.is_priority());
Returns true if Ready
is the empty set
See Poll
for more documentation on polling.
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.
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.
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
.
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
.
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.
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));
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
.
use mio::Ready;
let ready = Ready::readable();
let ready_usize = ready.as_usize();
let ready2 = Ready::from_usize(ready_usize);
assert_eq!(ready, ready2);
Performs copy-assignment from source
. Read more
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self | 1.21.0 [src] |
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self | 1.21.0 [src] |
Compares and returns the minimum of two values. Read more
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
This method tests for self
and other
values to be equal, and is used by ==
. Read more
This method tests for !=
.
Formats the value using the given formatter. Read more
The resulting type after applying the -
operator.
Performs the -
operation.
The resulting type after applying the &
operator.
Performs the &
operation.
The resulting type after applying the |
operator.
Performs the |
operation.
The resulting type after applying the ^
operator.
Performs the ^
operation.
The resulting type after dereferencing.
Mutably dereferences the value.
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
type Error = <U as TryFrom<T>>::Error
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static