Struct mio::PollOpt

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

Implementations

impl PollOpt

pub fn empty() -> PollOpt

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

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

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

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

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

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

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

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)

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)

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 BitAnd<PollOpt> for PollOpt

type Output = PollOpt

The resulting type after applying the & operator.

fn bitand(self, other: PollOpt) -> PollOpt

Performs the & operation.

impl BitOr<PollOpt> for PollOpt

type Output = PollOpt

The resulting type after applying the | operator.

fn bitor(self, other: PollOpt) -> PollOpt

Performs the | operation.

impl BitXor<PollOpt> for PollOpt

type Output = PollOpt

The resulting type after applying the ^ operator.

fn bitxor(self, other: PollOpt) -> PollOpt

Performs the ^ operation.

impl Clone for PollOpt

fn clone(&self) -> PollOpt

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for PollOpt

impl Debug for PollOpt

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for PollOpt

impl Ord for PollOpt

fn cmp(&self, other: &PollOpt) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<PollOpt> for PollOpt

fn eq(&self, other: &PollOpt) -> bool

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

fn ne(&self, other: &PollOpt) -> bool

This method tests for !=.

impl PartialOrd<PollOpt> for PollOpt

fn partial_cmp(&self, other: &PollOpt) -> Option<Ordering>

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

fn lt(&self, other: &PollOpt) -> bool

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

fn le(&self, other: &PollOpt) -> bool

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

fn gt(&self, other: &PollOpt) -> bool

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

fn ge(&self, other: &PollOpt) -> bool

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

impl StructuralEq for PollOpt

impl StructuralPartialEq for PollOpt

impl Sub<PollOpt> for PollOpt

type Output = PollOpt

The resulting type after applying the - operator.

fn sub(self, other: PollOpt) -> PollOpt

Performs the - operation.