Struct mio::PollOpt
[−]
[src]
pub struct PollOpt(_);
Options supplied when registering an Evented
handle with Poll
PollOpt
values can be combined together using the various bitwise
operators.
For high level documentation on polling and poll options, see Poll
.
Examples
use mio::PollOpt; let opts = PollOpt::edge() | PollOpt::oneshot(); assert!(opts.is_edge()); assert!(opts.is_oneshot()); assert!(!opts.is_level());
Methods
impl PollOpt
[src]
pub fn empty() -> PollOpt
[src]
Return a PollOpt
representing no set options.
See Poll
for more documentation on polling.
Examples
use mio::PollOpt; let opt = PollOpt::empty(); assert!(!opt.is_level());
pub fn edge() -> PollOpt
[src]
Return a PollOpt
representing edge-triggered notifications.
See Poll
for more documentation on polling.
Examples
use mio::PollOpt; let opt = PollOpt::edge(); assert!(opt.is_edge());
pub fn level() -> PollOpt
[src]
Return a PollOpt
representing level-triggered notifications.
See Poll
for more documentation on polling.
Examples
use mio::PollOpt; let opt = PollOpt::level(); assert!(opt.is_level());
pub fn oneshot() -> PollOpt
[src]
Return a PollOpt
representing oneshot notifications.
See Poll
for more documentation on polling.
Examples
use mio::PollOpt; let opt = PollOpt::oneshot(); assert!(opt.is_oneshot());
pub fn is_edge(&self) -> bool
[src]
Returns true if the options include edge-triggered notifications.
See Poll
for more documentation on polling.
Examples
use mio::PollOpt; let opt = PollOpt::edge(); assert!(opt.is_edge());
pub fn is_level(&self) -> bool
[src]
Returns true if the options include level-triggered notifications.
See Poll
for more documentation on polling.
Examples
use mio::PollOpt; let opt = PollOpt::level(); assert!(opt.is_level());
pub fn is_oneshot(&self) -> bool
[src]
Returns true if the options includes oneshot.
See Poll
for more documentation on polling.
Examples
use mio::PollOpt; let opt = PollOpt::oneshot(); assert!(opt.is_oneshot());
pub fn contains(&self, other: PollOpt) -> bool
[src]
Returns true if self
is a superset of other
.
other
may represent more than one option, in which case the function
only returns true if self
contains all of the options specified in
other
.
See Poll
for more documentation on polling.
Examples
use mio::PollOpt; let opt = PollOpt::oneshot(); assert!(opt.contains(PollOpt::oneshot())); assert!(!opt.contains(PollOpt::edge()));
use mio::PollOpt; let opt = PollOpt::oneshot() | PollOpt::edge(); assert!(opt.contains(PollOpt::oneshot())); assert!(opt.contains(PollOpt::edge()));
use mio::PollOpt; let opt = PollOpt::oneshot() | PollOpt::edge(); assert!(!PollOpt::oneshot().contains(opt)); assert!(opt.contains(opt)); assert!((opt | PollOpt::level()).contains(opt));
pub fn insert(&mut self, other: PollOpt)
[src]
Adds all options represented by other
into self
.
This is equivalent to *self = *self | other
.
Examples
use mio::PollOpt; let mut opt = PollOpt::empty(); opt.insert(PollOpt::oneshot()); assert!(opt.is_oneshot());
pub fn remove(&mut self, other: PollOpt)
[src]
Removes all options represented by other
from self
.
This is equivalent to *self = *self & !other
.
Examples
use mio::PollOpt; let mut opt = PollOpt::oneshot(); opt.remove(PollOpt::oneshot()); assert!(!opt.is_oneshot());
Trait Implementations
impl Copy for PollOpt
[src]
impl PartialEq for PollOpt
[src]
fn eq(&self, __arg_0: &PollOpt) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &PollOpt) -> bool
[src]
This method tests for !=
.
impl Eq for PollOpt
[src]
impl Clone for PollOpt
[src]
fn clone(&self) -> PollOpt
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialOrd for PollOpt
[src]
fn partial_cmp(&self, __arg_0: &PollOpt) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &PollOpt) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &PollOpt) -> bool
[src]
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: &PollOpt) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &PollOpt) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for PollOpt
[src]
fn cmp(&self, __arg_0: &PollOpt) -> Ordering
[src]
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
impl BitOr for PollOpt
[src]
type Output = PollOpt
The resulting type after applying the |
operator.
fn bitor(self, other: PollOpt) -> PollOpt
[src]
Performs the |
operation.
impl BitXor for PollOpt
[src]
type Output = PollOpt
The resulting type after applying the ^
operator.
fn bitxor(self, other: PollOpt) -> PollOpt
[src]
Performs the ^
operation.
impl BitAnd for PollOpt
[src]
type Output = PollOpt
The resulting type after applying the &
operator.
fn bitand(self, other: PollOpt) -> PollOpt
[src]
Performs the &
operation.
impl Sub for PollOpt
[src]
type Output = PollOpt
The resulting type after applying the -
operator.
fn sub(self, other: PollOpt) -> PollOpt
[src]
Performs the -
operation.