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
.
use mio::Ready;
let ready = Ready::readable() | Ready::writable();
assert!(ready.is_readable());
assert!(ready.is_writable());
Returns the empty Ready
set.
See Poll
for more documentation on polling.
use mio::Ready;
let ready = Ready::empty();
assert!(!ready.is_readable());
Returns a Ready
representing readable readiness.
See Poll
for more documentation on polling.
use mio::Ready;
let ready = Ready::readable();
assert!(ready.is_readable());
Returns a Ready
representing writable readiness.
See Poll
for more documentation on polling.
use mio::Ready;
let ready = Ready::writable();
assert!(ready.is_writable());
Returns a Ready
representing readiness for all operations.
This includes platform specific operations as well (hup
, aio
,
error
, lio
).
See Poll
for more documentation on polling.
use mio::Ready;
let ready = Ready::all();
assert!(ready.is_readable());
assert!(ready.is_writable());
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));
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
.
use mio::Ready;
let ready = Ready::readable();
let ready_usize = ready.as_usize();
let ready2 = Ready::from_usize(ready_usize);
assert_eq!(ready, ready2);
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.
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.
Performs the &=
operation.
Performs the |=
operation.
Performs the ^=
operation.
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