[−][src]Struct mio::unix::UnixReady
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
.
Examples
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; // Start with a portable ready let ready = Ready::readable(); // Convert to a unix ready, adding HUP let mut unix_ready = UnixReady::from(ready) | UnixReady::hup(); unix_ready.insert(UnixReady::error()); // `unix_ready` maintains readable interest assert!(unix_ready.is_readable()); assert!(unix_ready.is_hup()); assert!(unix_ready.is_error()); // Convert back to `Ready` let ready = Ready::from(unix_ready); // Readable is maintained 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())?;
Implementations
impl UnixReady
[src]
pub fn error() -> UnixReady
[src]
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 mio::unix::UnixReady; let ready = UnixReady::error(); assert!(ready.is_error());
pub fn hup() -> UnixReady
[src]
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. It is also unclear if HUP readiness will remain in 0.7. See
here.
See Poll
for more documentation on polling.
Examples
use mio::unix::UnixReady; let ready = UnixReady::hup(); assert!(ready.is_hup());
pub fn priority() -> UnixReady
[src]
Returns a Ready
representing priority (EPOLLPRI
) readiness
See Poll
for more documentation on polling.
Examples
use mio::unix::UnixReady; let ready = UnixReady::priority(); assert!(ready.is_priority());
pub fn is_error(&self) -> bool
[src]
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 mio::unix::UnixReady; let ready = UnixReady::error(); assert!(ready.is_error());
pub fn is_hup(&self) -> bool
[src]
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 mio::unix::UnixReady; let ready = UnixReady::hup(); assert!(ready.is_hup());
pub fn is_priority(&self) -> bool
[src]
Methods from Deref<Target = Ready>
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 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 BitAnd<UnixReady> for UnixReady
[src]
type Output = UnixReady
The resulting type after applying the &
operator.
fn bitand(self, other: UnixReady) -> UnixReady
[src]
impl BitOr<UnixReady> for UnixReady
[src]
type Output = UnixReady
The resulting type after applying the |
operator.
fn bitor(self, other: UnixReady) -> UnixReady
[src]
impl BitXor<UnixReady> for UnixReady
[src]
type Output = UnixReady
The resulting type after applying the ^
operator.
fn bitxor(self, other: UnixReady) -> UnixReady
[src]
impl Clone for UnixReady
[src]
impl Copy for UnixReady
[src]
impl Debug for UnixReady
[src]
impl Deref for UnixReady
[src]
impl DerefMut for UnixReady
[src]
impl Eq for UnixReady
[src]
impl From<Ready> for UnixReady
[src]
impl From<UnixReady> for Ready
[src]
impl Ord for UnixReady
[src]
fn cmp(&self, other: &UnixReady) -> 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<UnixReady> for UnixReady
[src]
impl PartialOrd<UnixReady> for UnixReady
[src]
fn partial_cmp(&self, other: &UnixReady) -> Option<Ordering>
[src]
fn lt(&self, other: &UnixReady) -> bool
[src]
fn le(&self, other: &UnixReady) -> bool
[src]
fn gt(&self, other: &UnixReady) -> bool
[src]
fn ge(&self, other: &UnixReady) -> bool
[src]
impl StructuralEq for UnixReady
[src]
impl StructuralPartialEq for UnixReady
[src]
impl Sub<UnixReady> for UnixReady
[src]
Auto Trait Implementations
impl RefUnwindSafe for UnixReady
impl Send for UnixReady
impl Sync for UnixReady
impl Unpin for UnixReady
impl UnwindSafe for UnixReady
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>,