pub struct Ready(/* private fields */);
Expand description
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 corcovado::Ready;
let ready = Ready::readable() | Ready::writable();
assert!(ready.is_readable());
assert!(ready.is_writable());
Implementations§
source§impl Ready
impl Ready
pub fn none() -> Ready
pub fn error() -> Ready
pub fn hup() -> Ready
sourcepub fn all() -> Ready
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 corcovado::Ready;
let ready = Ready::all();
assert!(ready.is_readable());
assert!(ready.is_writable());
pub fn is_none(&self) -> bool
sourcepub fn is_readable(&self) -> bool
pub fn is_readable(&self) -> bool
sourcepub fn is_writable(&self) -> bool
pub fn is_writable(&self) -> bool
pub fn is_error(&self) -> bool
pub fn is_hup(&self) -> bool
sourcepub fn insert<T: Into<Self>>(&mut self, other: T)
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 corcovado::Ready;
let mut readiness = Ready::empty();
readiness.insert(Ready::readable());
assert!(readiness.is_readable());
sourcepub fn remove<T: Into<Self>>(&mut self, other: T)
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 corcovado::Ready;
let mut readiness = Ready::readable();
readiness.remove(Ready::readable());
assert!(!readiness.is_readable());
pub fn bits(&self) -> usize
sourcepub fn contains<T: Into<Self>>(&self, other: T) -> bool
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 corcovado::Ready;
let readiness = Ready::readable();
assert!(readiness.contains(Ready::readable()));
assert!(!readiness.contains(Ready::writable()));
use corcovado::Ready;
let readiness = Ready::readable() | Ready::writable();
assert!(readiness.contains(Ready::readable()));
assert!(readiness.contains(Ready::writable()));
use corcovado::Ready;
let readiness = Ready::readable() | Ready::writable();
assert!(!Ready::readable().contains(readiness));
assert!(readiness.contains(readiness));
sourcepub fn from_usize(val: usize) -> Ready
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 corcovado::Ready;
let ready = Ready::readable();
let ready_usize = ready.as_usize();
let ready2 = Ready::from_usize(ready_usize);
assert_eq!(ready, ready2);
sourcepub fn as_usize(&self) -> usize
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 corcovado::Ready;
let ready = Ready::readable();
let ready_usize = ready.as_usize();
let ready2 = Ready::from_usize(ready_usize);
assert_eq!(ready, ready2);
Trait Implementations§
source§impl<T: Into<Ready>> BitAndAssign<T> for Ready
impl<T: Into<Ready>> BitAndAssign<T> for Ready
source§fn bitand_assign(&mut self, other: T)
fn bitand_assign(&mut self, other: T)
&=
operation. Read moresource§impl<T: Into<Ready>> BitOrAssign<T> for Ready
impl<T: Into<Ready>> BitOrAssign<T> for Ready
source§fn bitor_assign(&mut self, other: T)
fn bitor_assign(&mut self, other: T)
|=
operation. Read moresource§impl<T: Into<Ready>> BitXorAssign<T> for Ready
impl<T: Into<Ready>> BitXorAssign<T> for Ready
source§fn bitxor_assign(&mut self, other: T)
fn bitxor_assign(&mut self, other: T)
^=
operation. Read moresource§impl Ord for Ready
impl Ord for Ready
source§impl PartialOrd for Ready
impl PartialOrd for Ready
source§impl<T: Into<Ready>> SubAssign<T> for Ready
impl<T: Into<Ready>> SubAssign<T> for Ready
source§fn sub_assign(&mut self, other: T)
fn sub_assign(&mut self, other: T)
-=
operation. Read moreimpl Copy for Ready
impl Eq for Ready
impl StructuralPartialEq for Ready
Auto Trait Implementations§
impl Freeze for Ready
impl RefUnwindSafe for Ready
impl Send for Ready
impl Sync for Ready
impl Unpin for Ready
impl UnwindSafe for Ready
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)