Struct nix::poll::PollFlags

pub struct PollFlags { /* fields omitted */ }

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

Implementations

impl PollFlags

pub const POLLIN: PollFlags

There is data to read.

pub const POLLPRI: PollFlags

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: PollFlags

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: PollFlags

Equivalent to POLLIN

pub const POLLWRNORM: PollFlags

Equivalent to POLLOUT

pub const POLLRDBAND: PollFlags

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

pub const POLLWRBAND: PollFlags

Priority data may be written.

pub const POLLERR: PollFlags

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: PollFlags

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: PollFlags

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

pub const fn empty() -> PollFlags

Returns an empty set of flags

pub const fn all() -> PollFlags

Returns the set containing all flags.

pub const fn bits(&self) -> c_short

Returns the raw value of the flags currently stored.

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

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

pub const fn from_bits_truncate(bits: c_short) -> PollFlags

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

pub const unsafe fn from_bits_unchecked(bits: c_short) -> PollFlags

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: PollFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for PollFlags

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

Formats the value using the given formatter.

impl BitAnd<PollFlags> for PollFlags

type Output = PollFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<PollFlags> for PollFlags

fn bitand_assign(&mut self, other: PollFlags)

Disables all flags disabled in the set.

impl BitOr<PollFlags> for PollFlags

type Output = PollFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<PollFlags> for PollFlags

fn bitor_assign(&mut self, other: PollFlags)

Adds the set of flags.

impl BitXor<PollFlags> for PollFlags

type Output = PollFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<PollFlags> for PollFlags

fn bitxor_assign(&mut self, other: PollFlags)

Toggles the set of flags.

impl Clone for PollFlags

fn clone(&self) -> PollFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PollFlags

impl Debug for PollFlags

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

Formats the value using the given formatter.

impl Eq for PollFlags

impl Extend<PollFlags> for PollFlags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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<PollFlags> for PollFlags

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

Creates a value from an iterator.

impl Hash for PollFlags

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

Feeds this value into the given Hasher.

pub 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 PollFlags

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

Formats the value using the given formatter.

impl Not for PollFlags

type Output = PollFlags

The resulting type after applying the ! operator.

fn not(self) -> PollFlags

Returns the complement of this set of flags.

impl Octal for PollFlags

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

Formats the value using the given formatter.

impl Ord for PollFlags

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<PollFlags> for PollFlags

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

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

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

This method tests for !=.

impl PartialOrd<PollFlags> for PollFlags

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl StructuralEq for PollFlags

impl StructuralPartialEq for PollFlags

impl Sub<PollFlags> for PollFlags

type Output = PollFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<PollFlags> for PollFlags

fn sub_assign(&mut self, other: PollFlags)

Disables all flags enabled in the set.

impl UpperHex for PollFlags

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

Formats the value using the given formatter.