Struct epoll::Events

pub struct Events { /* fields omitted */ }

Implementations

impl Events

pub const EPOLLET: Events

Sets the Edge Triggered behavior for the associated file descriptor.

The default behavior for epoll is Level Triggered.

pub const EPOLLIN: Events

The associated file is available for read operations.

pub const EPOLLERR: Events

Error condition happened on the associated file descriptor.

wait will always wait for this event; is not necessary to set it in events.

pub const EPOLLHUP: Events

Hang up happened on the associated file descriptor.

wait will always wait for this event; it is not necessary to set it in events. Note that when reading from a channel such as a pipe or a stream socket, this event merely indicates that the peer closed its end of the channel. Subsequent reads from the channel will return 0 (end of file) only after all outstanding data in the channel has been consumed.

pub const EPOLLOUT: Events

The associated file is available for write operations.

pub const EPOLLPRI: Events

There is urgent data available for read operations.

pub const EPOLLRDHUP: Events

Stream socket peer closed connection, or shut down writing half of connection.

This flag is especially useful for writing simple code to detect peer shutdown when using Edge Triggered monitoring.

pub const EPOLLWAKEUP: Events

If EPOLLONESHOT and EPOLLET are clear and the process has the CAP_BLOCK_SUSPEND capability, ensure that the system does not enter "suspend" or "hibernate" while this event is pending or being processed.

The event is considered as being "processed" from the time when it is returned by a call to wait until the next call to wait on the same EpollInstance descriptor, the closure of that file descriptor, the removal of the event file descriptor with EPOLL_CTL_DEL, or the clearing of EPOLLWAKEUP for the event file descriptor with EPOLL_CTL_MOD.

pub const EPOLLONESHOT: Events

Sets the one-shot behavior for the associated file descriptor.

This means that after an event is pulled out with wait the associated file descriptor is internally disabled and no other events will be reported by the epoll interface. The user must call ctl with EPOLL_CTL_MOD to rearm the file descriptor with a new event mask.

pub const EPOLLEXCLUSIVE: Events

Sets an exclusive wakeup mode for the epoll file descriptor that is being attached to the target file descriptor, fd. When a wakeup event occurs and multiple epoll file descriptors are attached to the same target file using EPOLLEXCLUSIVE, one or more of the epoll file descriptors will receive an event with wait. The default in this scenario (when EPOLLEXCLUSIVE is not set) is for all epoll file descriptors to receive an event. EPOLLEXCLUSIVE is thus useful for avoiding thundering herd problems in certain scenarios.

If the same file descriptor is in multiple epoll instances, some with the EPOLLEXCLUSIVE flag, and others without, then events will be provided to all epoll instances that did not specify EPOLLEXCLUSIVE, and at least one of the epoll instances that did specify EPOLLEXCLUSIVE.

The following values may be specified in conjunction with EPOLLEXCLUSIVE: EPOLLIN, EPOLLOUT, EPOLLWAKEUP, and EPOLLET. EPOLLHUP and EPOLLERR can also be specified, but this is not required: as usual, these events are always reported if they occur, regardless of whether they are specified in Events. Attempts to specify other values in Events yield the error EINVAL.

EPOLLEXCLUSIVE may be used only in an EPOLL_CTL_ADD operation; attempts to employ it with EPOLL_CTL_MOD yield an error. If EPOLLEXCLUSIVE has been set using ctl, then a subsequent EPOLL_CTL_MOD on the same epfd, fd pair yields an error. A call to ctl that specifies EPOLLEXCLUSIVE in Events and specifies the target file descriptor fd as an epoll instance will likewise fail. The error in all of these cases is EINVAL.

The EPOLLEXCLUSIVE flag is an input flag for the Event.events field when calling ctl; it is never returned by wait.

pub const fn empty() -> Events

Returns an empty set of flags

pub const fn all() -> Events

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<Events>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Events

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Events

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Events) -> bool

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Events)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Events)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Events)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Events, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for Events

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

Formats the value using the given formatter.

impl BitAnd<Events> for Events

type Output = Events

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Events> for Events

fn bitand_assign(&mut self, other: Events)

Disables all flags disabled in the set.

impl BitOr<Events> for Events

type Output = Events

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Events> for Events

fn bitor_assign(&mut self, other: Events)

Adds the set of flags.

impl BitXor<Events> for Events

type Output = Events

The resulting type after applying the ^ operator.

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

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<Events> for Events

fn bitxor_assign(&mut self, other: Events)

Toggles the set of flags.

impl Clone for Events

fn clone(&self) -> Events

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Events

impl Debug for Events

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

Formats the value using the given formatter.

impl Eq for Events

impl Extend<Events> for Events

fn extend<T: IntoIterator<Item = Events>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Events> for Events

fn from_iter<T: IntoIterator<Item = Events>>(iterator: T) -> Events

Creates a value from an iterator.

impl Hash for Events

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].

impl LowerHex for Events

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

Formats the value using the given formatter.

impl Not for Events

type Output = Events

The resulting type after applying the ! operator.

fn not(self) -> Events

Returns the complement of this set of flags.

impl Octal for Events

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

Formats the value using the given formatter.

impl Ord for Events

fn cmp(&self, other: &Events) -> 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<Events> for Events

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

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

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

This method tests for !=.

impl PartialOrd<Events> for Events

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Events

impl StructuralPartialEq for Events

impl Sub<Events> for Events

type Output = Events

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Events> for Events

fn sub_assign(&mut self, other: Events)

Disables all flags enabled in the set.

impl UpperHex for Events

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

Formats the value using the given formatter.