Struct gaea::event::Ready

#[repr(transparent)]
pub struct Ready(_);

A set of readiness event kinds.

Ready is a set of operation descriptors indicating which kind of operation is ready to be performed. For example, Ready::READABLE indicates that the associated Evented handle is ready to perform a read operation.

Ready values can be combined together using the various bitwise operators, see examples below.

For high level documentation on polling and readiness, see poll.

Examples

use gaea::Ready;

let ready = Ready::READABLE | Ready::WRITABLE;

assert!(ready.is_readable());
assert!(ready.is_writable());
assert!(!ready.is_error());

Methods

impl Ready

pub const EMPTY: Ready

Empty set.

pub const READABLE: Ready

Readable readiness.

pub const WRITABLE: Ready

Writable readiness.

pub const ERROR: Ready

Error readiness.

pub const TIMER: Ready

Deadline was elapsed.

pub const HUP: Ready

Hup readiness, this signal is Unix specific.

pub const fn contains(self, other: Ready) -> bool

Whether or not all flags in other are contained within self.

pub const fn is_readable(self) -> bool

Returns true if the value includes readable readiness.

pub const fn is_writable(self) -> bool

Returns true if the value includes writable readiness.

pub const fn is_error(self) -> bool

Returns true if the value includes error readiness.

pub const fn is_timer(self) -> bool

Returns true if a deadline has elapsed.

pub const fn is_hup(self) -> bool

Returns true if the value includes HUP readiness.

Trait Implementations

impl Eq for Ready

impl Ord for Ready

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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<Ready> for Ready

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

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

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

This method tests for !=.

impl Copy for Ready

impl Clone for Ready

fn clone(&self) -> Ready

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Ready> for Ready

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

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

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

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

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

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

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

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

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

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

impl Debug for Ready

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

Formats the value using the given formatter.

impl BitOr<Ready> for Ready

type Output = Self

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl BitOrAssign<Ready> for Ready

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl Hash for Ready

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, 

Feeds a slice of this type into the given [Hasher].