pub struct Events(_);
Implementations§
source§impl Events
impl Events
sourcepub const EPOLLET: Self = _
pub const EPOLLET: Self = _
Sets the Edge Triggered behavior for the associated file descriptor.
The default behavior for epoll is Level Triggered.
sourcepub const EPOLLERR: Self = _
pub const EPOLLERR: Self = _
Error condition happened on the associated file descriptor.
wait
will always wait for this event; is not necessary to set it in events.
sourcepub const EPOLLHUP: Self = _
pub const EPOLLHUP: Self = _
Hang up happened on the associated file descriptor.
wait
will always wait for this event; it is not necessary to set it in events.
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 EPOLLRDHUP: Self = _
pub const EPOLLRDHUP: Self = _
Stream socket peer closed connection, or shut down writing half of connection.
This flag is especially useful for writing simple code to detect peer shutdown when using Edge Triggered monitoring.
sourcepub const EPOLLWAKEUP: Self = _
pub const EPOLLWAKEUP: Self = _
If EPOLLONESHOT
and EPOLLET
are clear and the process has the CAP_BLOCK_SUSPEND
capability, ensure that the system does not enter “suspend” or “hibernate” while this
event is pending or being processed.
The event is considered as being “processed” from the time when it is returned by
a call to wait
until the next call to wait
on the same EpollInstance
descriptor, the closure of that file descriptor, the removal of the event file
descriptor with EPOLL_CTL_DEL
, or the clearing of EPOLLWAKEUP
for the event file
descriptor with EPOLL_CTL_MOD
.
sourcepub const EPOLLONESHOT: Self = _
pub const EPOLLONESHOT: Self = _
Sets the one-shot behavior for the associated file descriptor.
This means that after an event is pulled out with wait
the associated file
descriptor is internally disabled and no other events will be reported by the epoll
interface. The user must call ctl
with EPOLL_CTL_MOD
to rearm the file
descriptor with a new event mask.
sourcepub const EPOLLEXCLUSIVE: Self = _
pub const EPOLLEXCLUSIVE: Self = _
Sets an exclusive wakeup mode for the epoll file descriptor that is being attached to
the target file descriptor, fd
. When a wakeup event occurs and multiple epoll file
descriptors are attached to the same target file using EPOLLEXCLUSIVE
, one or more of
the epoll file descriptors will receive an event with wait
. The default in this
scenario (when EPOLLEXCLUSIVE
is not set) is for all epoll file descriptors to
receive an event. EPOLLEXCLUSIVE
is thus useful for avoiding thundering herd problems
in certain scenarios.
If the same file descriptor is in multiple epoll instances, some with the
EPOLLEXCLUSIVE
flag, and others without, then events will be provided to all epoll
instances that did not specify EPOLLEXCLUSIVE
, and at least one of the epoll
instances that did specify EPOLLEXCLUSIVE
.
The following values may be specified in conjunction with EPOLLEXCLUSIVE
: EPOLLIN
,
EPOLLOUT
, EPOLLWAKEUP
, and EPOLLET
. EPOLLHUP
and EPOLLERR
can also be
specified, but this is not required: as usual, these events are always reported if they
occur, regardless of whether they are specified in Events
. Attempts to specify other
values in Events
yield the error EINVAL
.
EPOLLEXCLUSIVE
may be used only in an EPOLL_CTL_ADD
operation; attempts to employ
it with EPOLL_CTL_MOD
yield an error. If EPOLLEXCLUSIVE
has been set using ctl
,
then a subsequent EPOLL_CTL_MOD
on the same epfd
, fd
pair yields an error. A call
to ctl
that specifies EPOLLEXCLUSIVE
in Events
and specifies the target file
descriptor fd
as an epoll instance will likewise fail. The error in all of these
cases is EINVAL
.
The EPOLLEXCLUSIVE
flag is an input flag for the Event.events
field when calling
ctl
; it is never returned by wait
.
source§impl Events
impl Events
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get the value for a flag from its stringified name.
Names are case-sensitive, so must correspond exactly to the identifier given to the flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: Self)
pub fn insert(&mut self, other: Self)
Inserts the specified flags in-place.
This method is equivalent to union
.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
Removes the specified flags in-place.
This method is equivalent to difference
.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
Toggles the specified flags in-place.
This method is equivalent to symmetric_difference
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub 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
.
Calculating self
bitwise and (&
) other, including
any bits that don’t correspond to a defined flag.
sourcepub 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
.
Calculates self
bitwise or (|
) other
, including
any bits that don’t correspond to a defined flag.
sourcepub 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
.
Calculates self
bitwise and (&!
) the bitwise negation of other
,
including any bits that don’t correspond to a defined flag.
This method is not equivalent to a & !b
when there are bits set that
don’t correspond to a defined flag. The !
operator will unset any
bits that don’t correspond to a flag, so they’ll always be unset by a &! b
,
but respected by a.difference(b)
.
sourcepub 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
.
Calculates self
bitwise exclusive or (^
) other
,
including any bits that don’t correspond to a defined flag.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Calculates the bitwise negation (!
) of self
,
unsetting any bits that don’t correspond to a defined flag.
Trait Implementations§
source§impl BitAndAssign<Events> for Events
impl BitAndAssign<Events> for Events
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOrAssign<Events> for Events
impl BitOrAssign<Events> for Events
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<Events> for Events
impl BitXorAssign<Events> for Events
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Extend<Events> for Events
impl Extend<Events> for Events
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 Events
impl Flags for Events
source§fn from_bits_retain(bits: u32) -> Events
fn from_bits_retain(bits: u32) -> Events
source§fn from_bits(bits: Self::Bits) -> Option<Self>
fn from_bits(bits: Self::Bits) -> Option<Self>
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> 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,
true
if there are flags common to both self
and other
.source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
true
if all of the flags in other
are contained within self
.source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where Self: Sized,
source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where Self: Sized,
source§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where Self: Sized,
source§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where Self: Sized,
source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
self
and other
.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
self
and other
.source§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
self
and other
.source§fn complement(self) -> Self
fn complement(self) -> Self
source§impl FromIterator<Events> for Events
impl FromIterator<Events> for Events
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl IntoIterator for Events
impl IntoIterator for Events
source§impl Ord for Events
impl Ord for Events
source§impl PartialEq<Events> for Events
impl PartialEq<Events> for Events
source§impl PartialOrd<Events> for Events
impl PartialOrd<Events> for Events
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 SubAssign<Events> for Events
impl SubAssign<Events> for Events
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.