Struct rustix::mm::MlockAllFlags
source · pub struct MlockAllFlags(/* private fields */);
Expand description
MCL_*
flags for use with mlockall
.
Implementations§
source§impl MlockAllFlags
impl MlockAllFlags
sourcepub const ONFAULT: Self = _
pub const ONFAULT: Self = _
Used together with MCL_CURRENT
, MCL_FUTURE
, or both. Mark all
current (with MCL_CURRENT
) or future (with MCL_FUTURE
) mappings
to lock pages when they are faulted in. When used with
MCL_CURRENT
, all present pages are locked, but mlockall
will
not fault in non-present pages. When used with MCL_FUTURE
, all
future mappings will be marked to lock pages when they are faulted
in, but they will not be populated by the lock when the mapping is
created. MCL_ONFAULT
must be used with either MCL_CURRENT
or
MCL_FUTURE
or both.
source§impl MlockAllFlags
impl MlockAllFlags
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> 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: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> 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 MlockAllFlags
impl MlockAllFlags
sourcepub const fn iter(&self) -> Iter<MlockAllFlags>
pub const fn iter(&self) -> Iter<MlockAllFlags>
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<MlockAllFlags>
pub const fn iter_names(&self) -> IterNames<MlockAllFlags>
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 Binary for MlockAllFlags
impl Binary for MlockAllFlags
source§impl BitAnd for MlockAllFlags
impl BitAnd for MlockAllFlags
source§impl BitAndAssign for MlockAllFlags
impl BitAndAssign for MlockAllFlags
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 BitOr for MlockAllFlags
impl BitOr for MlockAllFlags
source§fn bitor(self, other: MlockAllFlags) -> Self
fn bitor(self, other: MlockAllFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
source§type Output = MlockAllFlags
type Output = MlockAllFlags
|
operator.source§impl BitOrAssign for MlockAllFlags
impl BitOrAssign for MlockAllFlags
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 BitXor for MlockAllFlags
impl BitXor for MlockAllFlags
source§impl BitXorAssign for MlockAllFlags
impl BitXorAssign for MlockAllFlags
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 Clone for MlockAllFlags
impl Clone for MlockAllFlags
source§fn clone(&self) -> MlockAllFlags
fn clone(&self) -> MlockAllFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for MlockAllFlags
impl Debug for MlockAllFlags
source§impl Extend<MlockAllFlags> for MlockAllFlags
impl Extend<MlockAllFlags> for MlockAllFlags
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 MlockAllFlags
impl Flags for MlockAllFlags
source§const FLAGS: &'static [Flag<MlockAllFlags>] = _
const FLAGS: &'static [Flag<MlockAllFlags>] = _
source§fn from_bits_retain(bits: u32) -> MlockAllFlags
fn from_bits_retain(bits: u32) -> MlockAllFlags
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<MlockAllFlags> for MlockAllFlags
impl FromIterator<MlockAllFlags> for MlockAllFlags
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 Hash for MlockAllFlags
impl Hash for MlockAllFlags
source§impl IntoIterator for MlockAllFlags
impl IntoIterator for MlockAllFlags
source§impl LowerHex for MlockAllFlags
impl LowerHex for MlockAllFlags
source§impl Not for MlockAllFlags
impl Not for MlockAllFlags
source§impl Octal for MlockAllFlags
impl Octal for MlockAllFlags
source§impl PartialEq for MlockAllFlags
impl PartialEq for MlockAllFlags
source§impl PublicFlags for MlockAllFlags
impl PublicFlags for MlockAllFlags
source§impl Sub for MlockAllFlags
impl Sub for MlockAllFlags
source§fn sub(self, other: Self) -> Self
fn sub(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.
source§type Output = MlockAllFlags
type Output = MlockAllFlags
-
operator.source§impl SubAssign for MlockAllFlags
impl SubAssign for MlockAllFlags
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.
source§impl UpperHex for MlockAllFlags
impl UpperHex for MlockAllFlags
impl Copy for MlockAllFlags
impl Eq for MlockAllFlags
impl StructuralPartialEq for MlockAllFlags
Auto Trait Implementations§
impl Freeze for MlockAllFlags
impl RefUnwindSafe for MlockAllFlags
impl Send for MlockAllFlags
impl Sync for MlockAllFlags
impl Unpin for MlockAllFlags
impl UnwindSafe for MlockAllFlags
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)