Struct soio::Ready
[−]
[src]
pub struct Ready(_);
A set of readiness event kinds
Ready
is a set of operation descriptors indicating that an operation is
ready to be performed. For example, Ready::readable()
indicates that the
associated Evented
handle is ready to perform a read
operation.
Note that only readable and writable readiness is guaranteed to be
supported on all platforms. This means that error
and hup
readiness
should be treated as hints. For more details, see readiness in the poll
documentation.
Ready
values can be combined together using the various bitwise operators.
For high level documentation on polling and readiness, see Poll
.
Examples
use soio::Ready; let ready = Ready::readable() | Ready::writable(); assert!(ready.is_readable()); assert!(ready.is_writable());
Methods
impl Ready
[src]
fn empty() -> Ready
Returns the empty Ready
set.
See Poll
for more documentation on polling.
Examples
use soio::Ready; let ready = Ready::empty(); assert!(!ready.is_readable());
fn readable() -> Ready
Returns a Ready
representing readable readiness.
See Poll
for more documentation on polling.
Examples
use soio::Ready; let ready = Ready::readable(); assert!(ready.is_readable());
fn writable() -> Ready
Returns a Ready
representing writable readiness.
See Poll
for more documentation on polling.
Examples
use soio::Ready; let ready = Ready::writable(); assert!(ready.is_writable());
fn error() -> Ready
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 soio::Ready; let ready = Ready::error(); assert!(ready.is_error());
fn hup() -> Ready
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 soio::Ready; let ready = Ready::hup(); assert!(ready.is_hup());
fn is_empty(&self) -> bool
Returns true if Ready
is the empty set
See [Poll
] for more documentation on polling.
Examples
use soio::Ready; let ready = Ready::empty(); assert!(ready.is_empty());
fn is_readable(&self) -> bool
Returns true if the value includes readable readiness
See Poll
for more documentation on polling.
Examples
use soio::Ready; let ready = Ready::readable(); assert!(ready.is_readable());
fn is_writable(&self) -> bool
Returns true if the value includes writable readiness
See Poll
for more documentation on polling.
Examples
use soio::Ready; let ready = Ready::writable(); assert!(ready.is_writable());
fn is_error(&self) -> bool
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 soio::Ready; let ready = Ready::error(); assert!(ready.is_error());
fn is_hup(&self) -> bool
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 soio::Ready; let ready = Ready::hup(); assert!(ready.is_hup());
fn insert(&mut self, other: Ready)
Adds all readiness represented by other
into self
.
This is equivalent to *self = *self | other
.
Examples
use soio::Ready; let mut readiness = Ready::empty(); readiness.insert(Ready::readable()); assert!(readiness.is_readable());
fn remove(&mut self, other: Ready)
Removes all options represented by other
from self
.
This is equivalent to *self = *self & !other
.
Examples
use soio::Ready; let mut readiness = Ready::readable(); readiness.remove(Ready::readable()); assert!(!readiness.is_readable());
fn contains(&self, other: Ready) -> 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 soio::Ready; let readiness = Ready::readable(); assert!(readiness.contains(Ready::readable())); assert!(!readiness.contains(Ready::writable()));
use soio::Ready; let readiness = Ready::readable() | Ready::writable(); assert!(readiness.contains(Ready::readable())); assert!(readiness.contains(Ready::writable()));
use soio::Ready; let readiness = Ready::readable() | Ready::writable(); assert!(!Ready::readable().contains(readiness)); assert!(readiness.contains(readiness)); assert!((readiness | Ready::hup()).contains(readiness));
fn as_usize(&self) -> usize
Trait Implementations
impl Copy for Ready
[src]
impl PartialEq for Ready
[src]
fn eq(&self, __arg_0: &Ready) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Ready) -> bool
This method tests for !=
.
impl Eq for Ready
[src]
impl Clone for Ready
[src]
fn clone(&self) -> Ready
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl PartialOrd for Ready
[src]
fn partial_cmp(&self, __arg_0: &Ready) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &Ready) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &Ready) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &Ready) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &Ready) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for Ready
[src]
fn cmp(&self, __arg_0: &Ready) -> Ordering
This method returns an Ordering
between self
and other
. Read more
impl BitOr for Ready
[src]
type Output = Ready
The resulting type after applying the |
operator
fn bitor(self, other: Ready) -> Ready
The method for the |
operator
impl BitXor for Ready
[src]
type Output = Ready
The resulting type after applying the ^
operator
fn bitxor(self, other: Ready) -> Ready
The method for the ^
operator
impl BitAnd for Ready
[src]
type Output = Ready
The resulting type after applying the &
operator
fn bitand(self, other: Ready) -> Ready
The method for the &
operator
impl Sub for Ready
[src]
type Output = Ready
The resulting type after applying the -
operator
fn sub(self, other: Ready) -> Ready
The method for the -
operator
impl Not for Ready
[src]
type Output = Ready
The resulting type after applying the !
operator
fn not(self) -> Ready
The method for the unary !
operator