[]Struct nix::poll::PollFlags

pub struct PollFlags { /* fields omitted */ }

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

Methods

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

impl Eq for PollFlags

impl Clone for PollFlags

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl PartialOrd<PollFlags> for PollFlags

impl Extend<PollFlags> for PollFlags

impl PartialEq<PollFlags> for PollFlags

impl Ord for PollFlags

fn max(self, other: Self) -> Self1.21.0[src]

Compares and returns the maximum of two values. Read more

fn min(self, other: Self) -> Self1.21.0[src]

Compares and returns the minimum of two values. Read more

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

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

Restrict a value to a certain interval. Read more

impl Hash for PollFlags

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

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

impl Debug 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 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 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 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 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 BitAndAssign<PollFlags> for PollFlags

fn bitand_assign(&mut self, other: PollFlags)

Disables all flags disabled in the set.

impl BitOrAssign<PollFlags> for PollFlags

fn bitor_assign(&mut self, other: PollFlags)

Adds the set of flags.

impl BitXorAssign<PollFlags> for PollFlags

fn bitxor_assign(&mut self, other: PollFlags)

Toggles the set of flags.

impl FromIterator<PollFlags> for PollFlags

impl Octal for PollFlags

impl Binary for PollFlags

impl LowerHex for PollFlags

impl UpperHex for PollFlags

Auto Trait Implementations

impl Unpin for PollFlags

impl Sync for PollFlags

impl Send for PollFlags

impl UnwindSafe for PollFlags

impl RefUnwindSafe for PollFlags

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]