[][src]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[src]

pub const POLLIN: PollFlags[src]

There is data to read.

pub const POLLPRI: PollFlags[src]

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[src]

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[src]

Equivalent to POLLIN

pub const POLLWRNORM: PollFlags[src]

Equivalent to POLLOUT

pub const POLLRDBAND: PollFlags[src]

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

pub const POLLWRBAND: PollFlags[src]

Priority data may be written.

pub const POLLERR: PollFlags[src]

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[src]

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[src]

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

pub const fn empty() -> PollFlags[src]

Returns an empty set of flags

pub const fn all() -> PollFlags[src]

Returns the set containing all flags.

pub const fn bits(&self) -> c_short[src]

Returns the raw value of the flags currently stored.

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

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[src]

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[src]

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

pub const fn is_empty(&self) -> bool[src]

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool[src]

Returns true if all flags are currently set.

pub const fn intersects(&self, other: PollFlags) -> bool[src]

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for PollFlags[src]

impl BitAnd<PollFlags> for PollFlags[src]

type Output = PollFlags

The resulting type after applying the & operator.

fn bitand(self, other: PollFlags) -> PollFlags[src]

Returns the intersection between the two sets of flags.

impl BitAndAssign<PollFlags> for PollFlags[src]

fn bitand_assign(&mut self, other: PollFlags)[src]

Disables all flags disabled in the set.

impl BitOr<PollFlags> for PollFlags[src]

type Output = PollFlags

The resulting type after applying the | operator.

fn bitor(self, other: PollFlags) -> PollFlags[src]

Returns the union of the two sets of flags.

impl BitOrAssign<PollFlags> for PollFlags[src]

fn bitor_assign(&mut self, other: PollFlags)[src]

Adds the set of flags.

impl BitXor<PollFlags> for PollFlags[src]

type Output = PollFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: PollFlags) -> PollFlags[src]

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

impl BitXorAssign<PollFlags> for PollFlags[src]

fn bitxor_assign(&mut self, other: PollFlags)[src]

Toggles the set of flags.

impl Clone for PollFlags[src]

impl Copy for PollFlags[src]

impl Debug for PollFlags[src]

impl Eq for PollFlags[src]

impl Extend<PollFlags> for PollFlags[src]

impl FromIterator<PollFlags> for PollFlags[src]

impl Hash for PollFlags[src]

impl LowerHex for PollFlags[src]

impl Not for PollFlags[src]

type Output = PollFlags

The resulting type after applying the ! operator.

fn not(self) -> PollFlags[src]

Returns the complement of this set of flags.

impl Octal for PollFlags[src]

impl Ord for PollFlags[src]

impl PartialEq<PollFlags> for PollFlags[src]

impl PartialOrd<PollFlags> for PollFlags[src]

impl StructuralEq for PollFlags[src]

impl StructuralPartialEq for PollFlags[src]

impl Sub<PollFlags> for PollFlags[src]

type Output = PollFlags

The resulting type after applying the - operator.

fn sub(self, other: PollFlags) -> PollFlags[src]

Returns the set difference of the two sets of flags.

impl SubAssign<PollFlags> for PollFlags[src]

fn sub_assign(&mut self, other: PollFlags)[src]

Disables all flags enabled in the set.

impl UpperHex for PollFlags[src]

Auto Trait Implementations

impl RefUnwindSafe for PollFlags

impl Send for PollFlags

impl Sync for PollFlags

impl Unpin for PollFlags

impl UnwindSafe for PollFlags

Blanket Implementations

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

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

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

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

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

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

type Owned = T

The resulting type after obtaining ownership.

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.