Struct event_manager::EventSet
source · pub struct EventSet { /* private fields */ }
Expand description
The type of epoll events we can monitor a file descriptor for. The type of events we can monitor a file descriptor for.
Implementations§
source§impl EventSet
impl EventSet
sourcepub const READ_HANG_UP: EventSet = _
pub const READ_HANG_UP: EventSet = _
This can be used to detect peer shutdown when using Edge Triggered monitoring.
sourcepub const EDGE_TRIGGERED: EventSet = _
pub const EDGE_TRIGGERED: EventSet = _
Sets the Edge Triggered behavior for the associated file descriptor. The default behavior is Level Triggered.
sourcepub const HANG_UP: EventSet = _
pub const HANG_UP: EventSet = _
Hang up happened on the associated file descriptor. Note that epoll_wait
will always wait for this event and it is not necessary to set it in events.
sourcepub const PRIORITY: EventSet = _
pub const PRIORITY: EventSet = _
There is an exceptional condition on that file descriptor. It is mostly used to set high priority for some data.
sourcepub const WAKE_UP: EventSet = _
pub const WAKE_UP: EventSet = _
The event is considered as being “processed” from the time when it is returned
by a call to epoll_wait
until the next call to epoll_wait
on the same
epoll file descriptor, the closure of that file descriptor, the removal of the
event file descriptor via EPOLL_CTL_DEL, or the clearing of EPOLLWAKEUP
for the event file descriptor via EPOLL_CTL_MOD.
sourcepub const ONE_SHOT: EventSet = _
pub const ONE_SHOT: EventSet = _
Sets the one-shot behavior for the associated file descriptor.
sourcepub const EXCLUSIVE: EventSet = _
pub const EXCLUSIVE: EventSet = _
Sets an exclusive wake up mode for the epoll file descriptor that is being
attached to the associated file descriptor.
When a wake up event occurs and multiple epoll file descriptors are attached to
the same target file using this mode, one or more of the epoll file descriptors
will receive an event with epoll_wait
. The default here is for all those file
descriptors to receive an event.
sourcepub const fn from_bits(bits: u32) -> Option<EventSet>
pub const fn from_bits(bits: u32) -> Option<EventSet>
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) -> EventSet
pub const fn from_bits_truncate(bits: u32) -> EventSet
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> EventSet
pub const unsafe fn from_bits_unchecked(bits: u32) -> EventSet
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.
sourcepub const fn intersects(&self, other: EventSet) -> bool
pub const fn intersects(&self, other: EventSet) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: EventSet) -> bool
pub const fn contains(&self, other: EventSet) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: EventSet, value: bool)
pub fn set(&mut self, other: EventSet, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: EventSet) -> EventSet
pub const fn intersection(self, other: EventSet) -> EventSet
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
.
sourcepub const fn union(self, other: EventSet) -> EventSet
pub const fn union(self, other: EventSet) -> EventSet
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
.
sourcepub const fn difference(self, other: EventSet) -> EventSet
pub const fn difference(self, other: EventSet) -> EventSet
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
.
sourcepub const fn symmetric_difference(self, other: EventSet) -> EventSet
pub const fn symmetric_difference(self, other: EventSet) -> EventSet
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
.
sourcepub const fn complement(self) -> EventSet
pub const fn complement(self) -> EventSet
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§
source§impl BitAndAssign for EventSet
impl BitAndAssign for EventSet
source§fn bitand_assign(&mut self, other: EventSet)
fn bitand_assign(&mut self, other: EventSet)
Disables all flags disabled in the set.
source§impl BitOrAssign for EventSet
impl BitOrAssign for EventSet
source§fn bitor_assign(&mut self, other: EventSet)
fn bitor_assign(&mut self, other: EventSet)
Adds the set of flags.
source§impl BitXorAssign for EventSet
impl BitXorAssign for EventSet
source§fn bitxor_assign(&mut self, other: EventSet)
fn bitxor_assign(&mut self, other: EventSet)
Toggles the set of flags.
source§impl Extend<EventSet> for EventSet
impl Extend<EventSet> for EventSet
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = EventSet>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = EventSet>,
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 FromIterator<EventSet> for EventSet
impl FromIterator<EventSet> for EventSet
source§impl Ord for EventSet
impl Ord for EventSet
source§impl PartialEq for EventSet
impl PartialEq for EventSet
source§impl PartialOrd for EventSet
impl PartialOrd for EventSet
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 for EventSet
impl SubAssign for EventSet
source§fn sub_assign(&mut self, other: EventSet)
fn sub_assign(&mut self, other: EventSet)
Disables all flags enabled in the set.