#[repr(transparent)]pub struct PollFlags(_);
poll
only.Expand description
These flags define the different events that can be monitored by poll
and ppoll
Implementations§
source§impl PollFlags
impl PollFlags
sourcepub const POLLPRI: Self = _
pub 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)).
sourcepub const POLLOUT: Self = _
pub 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).
sourcepub const POLLRDNORM: Self = _
pub const POLLRDNORM: Self = _
Equivalent to POLLIN
sourcepub const POLLWRNORM: Self = _
pub const POLLWRNORM: Self = _
Equivalent to POLLOUT
sourcepub const POLLRDBAND: Self = _
pub const POLLRDBAND: Self = _
Priority band data can be read (generally unused on Linux).
sourcepub const POLLWRBAND: Self = _
pub const POLLWRBAND: Self = _
Priority data may be written.
sourcepub const POLLERR: Self = _
pub 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.
sourcepub const POLLHUP: Self = _
pub 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.
sourcepub const POLLNVAL: Self = _
pub const POLLNVAL: Self = _
Invalid request: fd
not open (only returned in
PollFd::revents
;
ignored in PollFd::new
).
source§impl PollFlags
impl PollFlags
sourcepub const fn bits(&self) -> c_short
pub const fn bits(&self) -> c_short
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: c_short) -> Option<Self>
pub const fn from_bits(bits: c_short) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: c_short) -> Self
pub const fn from_bits_truncate(bits: c_short) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: c_short) -> Self
pub const fn from_bits_retain(bits: c_short) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl PollFlags
impl PollFlags
sourcepub const fn iter(&self) -> Iter<PollFlags>
pub const fn iter(&self) -> Iter<PollFlags>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<PollFlags>
pub const fn iter_names(&self) -> IterNames<PollFlags>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
source§impl BitAndAssign<PollFlags> for PollFlags
impl BitAndAssign<PollFlags> for PollFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOrAssign<PollFlags> for PollFlags
impl BitOrAssign<PollFlags> for PollFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXorAssign<PollFlags> for PollFlags
impl BitXorAssign<PollFlags> for PollFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Extend<PollFlags> for PollFlags
impl Extend<PollFlags> for PollFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for PollFlags
impl Flags for PollFlags
source§fn from_bits_retain(bits: c_short) -> PollFlags
fn from_bits_retain(bits: c_short) -> PollFlags
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<PollFlags> for PollFlags
impl FromIterator<PollFlags> for PollFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl IntoIterator for PollFlags
impl IntoIterator for PollFlags
source§impl Ord for PollFlags
impl Ord for PollFlags
source§impl PartialEq<PollFlags> for PollFlags
impl PartialEq<PollFlags> for PollFlags
source§impl PartialOrd<PollFlags> for PollFlags
impl PartialOrd<PollFlags> for PollFlags
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub<PollFlags> for PollFlags
impl Sub<PollFlags> for PollFlags
source§impl SubAssign<PollFlags> for PollFlags
impl SubAssign<PollFlags> for PollFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.