[−][src]Struct mio::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());
Implementations
impl Ready
[src]
pub fn empty() -> 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());
pub fn readable() -> Ready
[src]
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());
pub fn writable() -> Ready
[src]
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());
pub fn all() -> Ready
[src]
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 mio::Ready; let ready = Ready::all(); assert!(ready.is_readable()); assert!(ready.is_writable());
pub fn is_empty(&self) -> bool
[src]
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());
pub fn is_readable(&self) -> bool
[src]
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());
pub fn is_writable(&self) -> bool
[src]
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());
pub fn insert<T: Into<Self>>(&mut self, other: T)
[src]
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());
pub fn remove<T: Into<Self>>(&mut self, other: T)
[src]
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());
pub fn contains<T: Into<Self>>(&self, other: T) -> bool
[src]
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));
pub fn from_usize(val: usize) -> Ready
[src]
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 mio::Ready; let ready = Ready::readable(); let ready_usize = ready.as_usize(); let ready2 = Ready::from_usize(ready_usize); assert_eq!(ready, ready2);
pub fn as_usize(&self) -> usize
[src]
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 mio::Ready; let ready = Ready::readable(); let ready_usize = ready.as_usize(); let ready2 = Ready::from_usize(ready_usize); assert_eq!(ready, ready2);
Trait Implementations
impl<T: Into<Ready>> BitAnd<T> for Ready
[src]
type Output = Ready
The resulting type after applying the &
operator.
fn bitand(self, other: T) -> Ready
[src]
impl<T: Into<Ready>> BitAndAssign<T> for Ready
[src]
fn bitand_assign(&mut self, other: T)
[src]
impl<T: Into<Ready>> BitOr<T> for Ready
[src]
type Output = Ready
The resulting type after applying the |
operator.
fn bitor(self, other: T) -> Ready
[src]
impl<T: Into<Ready>> BitOrAssign<T> for Ready
[src]
fn bitor_assign(&mut self, other: T)
[src]
impl<T: Into<Ready>> BitXor<T> for Ready
[src]
type Output = Ready
The resulting type after applying the ^
operator.
fn bitxor(self, other: T) -> Ready
[src]
impl<T: Into<Ready>> BitXorAssign<T> for Ready
[src]
fn bitxor_assign(&mut self, other: T)
[src]
impl Clone for Ready
[src]
impl Copy for Ready
[src]
impl Debug for Ready
[src]
impl Eq for Ready
[src]
impl From<Ready> for UnixReady
[src]
impl From<UnixReady> for Ready
[src]
impl Ord for Ready
[src]
fn cmp(&self, other: &Ready) -> Ordering
[src]
#[must_use]fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self
[src]
impl PartialEq<Ready> for Ready
[src]
impl PartialOrd<Ready> for Ready
[src]
fn partial_cmp(&self, other: &Ready) -> Option<Ordering>
[src]
fn lt(&self, other: &Ready) -> bool
[src]
fn le(&self, other: &Ready) -> bool
[src]
fn gt(&self, other: &Ready) -> bool
[src]
fn ge(&self, other: &Ready) -> bool
[src]
impl StructuralEq for Ready
[src]
impl StructuralPartialEq for Ready
[src]
impl<T: Into<Ready>> Sub<T> for Ready
[src]
type Output = Ready
The resulting type after applying the -
operator.
fn sub(self, other: T) -> Ready
[src]
impl<T: Into<Ready>> SubAssign<T> for Ready
[src]
fn sub_assign(&mut self, other: T)
[src]
Auto Trait Implementations
impl RefUnwindSafe for Ready
impl Send for Ready
impl Sync for Ready
impl Unpin for Ready
impl UnwindSafe for Ready
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut Tⓘ
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,