Struct nix::poll::PollFlags
pub struct PollFlags { /* fields hidden */ }Documentation
These flags define the different events that can be monitored by poll and ppoll
Implementations
impl PollFlags
const POLLIN: Self = _
There is data to read.
const POLLPRI: Self = _
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)).
const POLLOUT: Self = _
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).
const POLLRDNORM: Self = _
Equivalent to POLLIN
const POLLWRNORM: Self = _
Equivalent to POLLOUT
const POLLRDBAND: Self = _
Priority band data can be read (generally unused on Linux).
const POLLWRBAND: Self = _
Priority data may be written.
const POLLERR: Self = _
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.
const POLLHUP: Self = _
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.
const POLLNVAL: Self = _
Invalid request: fd not open (only returned in
PollFd::revents;
ignored in PollFd::new).
pub const fn empty() -> Self
Returns an empty set of flags.
pub const fn all() -> Self
Returns the set containing all flags.
pub const fn bits(&Self) -> libc::c_short
Returns the raw value of the flags currently stored.
pub const fn from_bits(bits: libc::c_short) -> $crate::_core::option::Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub const fn from_bits_truncate(bits: libc::c_short) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: libc::c_short) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags! macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked() has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
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: Self) -> bool
Returns true if there are flags common to both self and other.
pub const fn contains(&Self, other: Self) -> bool
Returns true if all of the flags in other are contained within self.
pub fn insert(&mut Self, other: Self)
Inserts the specified flags in-place.
pub fn remove(&mut Self, other: Self)
Removes the specified flags in-place.
pub fn toggle(&mut Self, other: Self)
Toggles the specified flags in-place.
pub fn set(
&mut Self,
other: Self,
value: bool
)
&mut Self,
other: Self,
value: bool
)
Inserts or removes the specified flags depending on the passed value.
#[must_use]
pub const fn intersection(Self, other: Self) -> Self
pub const fn intersection(Self, other: Self) -> Self
Returns the intersection between the flags in self and
other.
Specifically, the returned set contains only the flags which are
present in both self and other.
This is equivalent to using the & operator (e.g.
ops::BitAnd), as in flags & other.
#[must_use]
pub const fn union(Self, other: Self) -> Self
pub const fn union(Self, other: Self) -> Self
Returns the union of between the flags in self and other.
Specifically, the returned set contains all flags which are
present in either self or other, including any which are
present in both (see Self::symmetric_difference if that
is undesirable).
This is equivalent to using the | operator (e.g.
ops::BitOr), as in flags | other.
#[must_use]
pub const fn difference(Self, other: Self) -> Self
pub const fn difference(Self, other: Self) -> Self
Returns the difference between the flags in self and other.
Specifically, the returned set contains all flags present in
self, except for the ones present in other.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other (and this syntax is also supported).
This is equivalent to using the - operator (e.g.
ops::Sub), as in flags - other.
#[must_use]
pub const fn symmetric_difference(Self, other: Self) -> Self
pub const fn symmetric_difference(Self, other: Self) -> Self
Returns the symmetric difference between the flags
in self and other.
Specifically, the returned set contains the flags present which
are present in self or other, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self and other.
This is equivalent to using the ^ operator (e.g.
ops::BitXor), as in flags ^ other.
#[must_use]
pub const fn complement(Self) -> Self
pub const fn complement(Self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all() and self (e.g. Self::all() - self)
This is equivalent to using the ! operator (e.g.
ops::Not), as in !flags.
Trait Implementations
impl Binary for PollFlags
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl BitAndAssign<PollFlags> for PollFlags
fn bitand_assign(&mut Self, other: Self)
Disables all flags disabled in the set.
impl BitOrAssign<PollFlags> for PollFlags
fn bitor_assign(&mut Self, other: Self)
Adds the set of flags.
impl BitXorAssign<PollFlags> for PollFlags
fn bitxor_assign(&mut Self, other: Self)
Toggles the set of flags.
impl Debug for PollFlags
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl Extend<PollFlags> for PollFlags
fn extend<T: $crate::_core::iter::IntoIterator<Item = Self>>(&mut Self, iterator: T)impl FromIterator<PollFlags> for PollFlags
fn from_iter<T: $crate::_core::iter::IntoIterator<Item = Self>>(iterator: T) -> Selfimpl Hash for PollFlags
fn hash<__H: $crate::hash::Hasher>(&Self, state: &mut __H) -> ()impl LowerHex for PollFlags
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl Octal for PollFlags
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl Ord for PollFlags
fn cmp(&Self, other: &PollFlags) -> $crate::cmp::Orderingimpl PartialOrd<PollFlags> for PollFlags
fn partial_cmp(&Self, other: &PollFlags) -> $crate::option::Option<$crate::cmp::Ordering>impl StructuralEq for PollFlagsimpl StructuralPartialEq for PollFlagsimpl SubAssign<PollFlags> for PollFlags
fn sub_assign(&mut Self, other: Self)
Disables all flags enabled in the set.
impl UpperHex for PollFlags
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::ResultAuto Trait Implementations
impl RefUnwindSafe for PollFlagsimpl UnwindSafe for PollFlagsBlanket Implementations
impl<T> BorrowMut<T> for T
where
T: ?Sized,
where
T: ?Sized,
fn borrow_mut(&mut Self) -> &mut T