Enum polling::PollMode

#[non_exhaustive]
pub enum PollMode {
    Oneshot,
    Level,
    Edge,
    EdgeOneshot,
}

The mode in which the poller waits for I/O events.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Oneshot

Poll in oneshot mode.

In this mode, the poller will only deliver one event per file descriptor or socket. Once an event has been delivered, interest in the event needs to be re-enabled by calling Poller::modify or Poller::add.

This is the default mode.

Level

Poll in level-triggered mode.

Once an event has been delivered, polling will continue to deliver that event until interest in the event is disabled by calling Poller::modify or Poller::delete.

Not all operating system support this mode. Trying to register a file descriptor with this mode in an unsupported operating system will raise an error. You can check if the operating system supports this mode by calling Poller::supports_level.

Edge

Poll in edge-triggered mode.

Once an event has been delivered, polling will not deliver that event again unless a new event occurs.

Not all operating system support this mode. Trying to register a file descriptor with this mode in an unsupported operating system will raise an error. You can check if the operating system supports this mode by calling Poller::supports_edge.

EdgeOneshot

Poll in both edge-triggered and oneshot mode.

This mode is similar to the Oneshot mode, but it will only deliver one event per new event.

Not all operating system support this mode. Trying to register a file descriptor with this mode in an unsupported operating system will raise an error. You can check if the operating system supports this mode by calling Poller::supports_edge.

Trait Implementations

impl Clone for PollMode

fn clone(&self) -> PollMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PollMode

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

Formats the value using the given formatter.

impl Hash for PollMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PollMode

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for PollMode

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PollMode

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for PollMode

impl Eq for PollMode

impl StructuralPartialEq for PollMode