Struct rustix::fs::inotify::WatchFlags
source · pub struct WatchFlags { /* private fields */ }
Expand description
IN*
for use with inotify_add_watch
.
Implementations§
source§impl WatchFlags
impl WatchFlags
sourcepub const CLOSE_NOWRITE: Self = _
pub const CLOSE_NOWRITE: Self = _
IN_CLOSE_NOWRITE
sourcepub const CLOSE_WRITE: Self = _
pub const CLOSE_WRITE: Self = _
IN_CLOSE_WRITE
sourcepub const DELETE_SELF: Self = _
pub const DELETE_SELF: Self = _
IN_DELETE_SELF
sourcepub const MOVED_FROM: Self = _
pub const MOVED_FROM: Self = _
IN_MOVED_FROM
sourcepub const ALL_EVENTS: Self = _
pub const ALL_EVENTS: Self = _
IN_ALL_EVENTS
sourcepub const DONT_FOLLOW: Self = _
pub const DONT_FOLLOW: Self = _
IN_DONT_FOLLOW
sourcepub const EXCL_UNLINK: Self = _
pub const EXCL_UNLINK: Self = _
IN_EXCL_UNLINK
sourcepub const MASK_CREATE: Self = _
pub const MASK_CREATE: Self = _
IN_MASK_CREATE
sourcepub const fn from_bits(bits: c_uint) -> Option<Self>
pub const fn from_bits(bits: c_uint) -> 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: c_uint) -> Self
pub const fn from_bits_truncate(bits: c_uint) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: c_uint) -> Self
pub const unsafe fn from_bits_unchecked(bits: c_uint) -> 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.
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 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
.
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: 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
.
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
.
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: 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
.
sourcepub 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§
source§impl Binary for WatchFlags
impl Binary for WatchFlags
source§impl BitAnd<WatchFlags> for WatchFlags
impl BitAnd<WatchFlags> for WatchFlags
source§impl BitAndAssign<WatchFlags> for WatchFlags
impl BitAndAssign<WatchFlags> for WatchFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<WatchFlags> for WatchFlags
impl BitOr<WatchFlags> for WatchFlags
source§fn bitor(self, other: WatchFlags) -> Self
fn bitor(self, other: WatchFlags) -> Self
Returns the union of the two sets of flags.
§type Output = WatchFlags
type Output = WatchFlags
|
operator.source§impl BitOrAssign<WatchFlags> for WatchFlags
impl BitOrAssign<WatchFlags> for WatchFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<WatchFlags> for WatchFlags
impl BitXor<WatchFlags> for WatchFlags
source§impl BitXorAssign<WatchFlags> for WatchFlags
impl BitXorAssign<WatchFlags> for WatchFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for WatchFlags
impl Clone for WatchFlags
source§fn clone(&self) -> WatchFlags
fn clone(&self) -> WatchFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for WatchFlags
impl Debug for WatchFlags
source§impl Default for WatchFlags
impl Default for WatchFlags
source§fn default() -> WatchFlags
fn default() -> WatchFlags
source§impl Extend<WatchFlags> for WatchFlags
impl Extend<WatchFlags> for WatchFlags
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 FromIterator<WatchFlags> for WatchFlags
impl FromIterator<WatchFlags> for WatchFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for WatchFlags
impl Hash for WatchFlags
source§impl LowerHex for WatchFlags
impl LowerHex for WatchFlags
source§impl Not for WatchFlags
impl Not for WatchFlags
source§impl Octal for WatchFlags
impl Octal for WatchFlags
source§impl Ord for WatchFlags
impl Ord for WatchFlags
source§fn cmp(&self, other: &WatchFlags) -> Ordering
fn cmp(&self, other: &WatchFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<WatchFlags> for WatchFlags
impl PartialEq<WatchFlags> for WatchFlags
source§fn eq(&self, other: &WatchFlags) -> bool
fn eq(&self, other: &WatchFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<WatchFlags> for WatchFlags
impl PartialOrd<WatchFlags> for WatchFlags
source§fn partial_cmp(&self, other: &WatchFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &WatchFlags) -> Option<Ordering>
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<WatchFlags> for WatchFlags
impl Sub<WatchFlags> for WatchFlags
source§impl SubAssign<WatchFlags> for WatchFlags
impl SubAssign<WatchFlags> for WatchFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.