pub struct PollOpt(usize);
Expand description

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());

Tuple Fields

0: usize

Implementations

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());

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());

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());

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());

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());

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());

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());

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));

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());

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

The resulting type after applying the & operator.

Performs the & operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

This method returns an ordering between self and other values if one exists. Read more

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.