Struct nix::poll::EventFlags

pub struct EventFlags { /* fields omitted */ }

These flags define the different events that can be monitored by poll and ppoll

Methods

impl EventFlags

pub const POLLIN: EventFlags

POLLIN: EventFlags = EventFlags{bits: libc::POLLIN,}

There is data to read.

pub const POLLPRI: EventFlags

POLLPRI: EventFlags = EventFlags{bits: libc::POLLPRI,}

There is some exceptional condition on the file descriptor.

Possibilities include:

• There is out-of-band data on a TCP socket (see tcp(7)).
• A pseudoterminal master in packet mode has seen a state change on the slave (see ioctl_tty(2)).
• A cgroup.events file has been modified (see cgroups(7)).

pub const POLLOUT: EventFlags

POLLOUT: EventFlags = EventFlags{bits: libc::POLLOUT,}

Writing is now possible, though a write larger that the available space in a socket or pipe will still block (unless O_NONBLOCK is set).

pub const POLLRDNORM: EventFlags

POLLRDNORM: EventFlags = EventFlags{bits: libc::POLLRDNORM,}

Equivalent to POLLIN

pub const POLLWRNORM: EventFlags

POLLWRNORM: EventFlags = EventFlags{bits: libc::POLLWRNORM,}

Equivalent to POLLOUT

pub const POLLRDBAND: EventFlags

POLLRDBAND: EventFlags = EventFlags{bits: libc::POLLRDBAND,}

Priority band data can be read (generally unused on Linux).

pub const POLLWRBAND: EventFlags

POLLWRBAND: EventFlags = EventFlags{bits: libc::POLLWRBAND,}

Priority data may be written.

pub const POLLERR: EventFlags

POLLERR: EventFlags = EventFlags{bits: libc::POLLERR,}

Error condition (only returned in PollFd::revents; ignored in PollFd::new). This bit is also set for a file descriptor referring to the write end of a pipe when the read end has been closed.

pub const POLLHUP: EventFlags

POLLHUP: EventFlags = EventFlags{bits: libc::POLLHUP,}

Hang up (only returned in PollFd::revents; ignored in PollFd::new). 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 POLLNVAL: EventFlags

POLLNVAL: EventFlags = EventFlags{bits: libc::POLLNVAL,}

Invalid request: fd not open (only returned in PollFd::revents; ignored in PollFd::new).

pub fn empty() -> EventFlags

Returns an empty set of flags.

pub fn all() -> EventFlags

Returns the set containing all flags.

pub fn bits(&self) -> c_short

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_short) -> Option<EventFlags>

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

pub fn from_bits_truncate(bits: c_short) -> EventFlags

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

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Copy for EventFlags

impl PartialEq for EventFlags

fn eq(&self, __arg_0: &EventFlags) -> bool

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

fn ne(&self, __arg_0: &EventFlags) -> bool

This method tests for !=.

impl Eq for EventFlags

impl Clone for EventFlags

fn clone(&self) -> EventFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd for EventFlags

fn partial_cmp(&self, __arg_0: &EventFlags) -> Option<Ordering>

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

fn lt(&self, __arg_0: &EventFlags) -> bool

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

fn le(&self, __arg_0: &EventFlags) -> bool

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

fn gt(&self, __arg_0: &EventFlags) -> bool

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

fn ge(&self, __arg_0: &EventFlags) -> bool

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

impl Ord for EventFlags

fn cmp(&self, __arg_0: &EventFlags) -> 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.

impl Hash for EventFlags

fn hash<__H: Hasher>(&self, __arg_0: &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 Debug for EventFlags

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

Formats the value using the given formatter.

impl Binary for EventFlags

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

Formats the value using the given formatter.

impl Octal for EventFlags

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

Formats the value using the given formatter.

impl LowerHex for EventFlags

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

Formats the value using the given formatter.

impl UpperHex for EventFlags

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

Formats the value using the given formatter.

impl BitOr for EventFlags

type Output = EventFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign for EventFlags

fn bitor_assign(&mut self, other: EventFlags)

Adds the set of flags.

impl BitXor for EventFlags

type Output = EventFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign for EventFlags

fn bitxor_assign(&mut self, other: EventFlags)

Toggles the set of flags.

impl BitAnd for EventFlags

type Output = EventFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign for EventFlags

fn bitand_assign(&mut self, other: EventFlags)

Disables all flags disabled in the set.

impl Sub for EventFlags

type Output = EventFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign for EventFlags

fn sub_assign(&mut self, other: EventFlags)

Disables all flags enabled in the set.

impl Not for EventFlags

type Output = EventFlags

The resulting type after applying the ! operator.

fn not(self) -> EventFlags

Returns the complement of this set of flags.

impl Extend<EventFlags> for EventFlags

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

Extends a collection with the contents of an iterator.

impl FromIterator<EventFlags> for EventFlags

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

Creates a value from an iterator.