Struct procfs_core::process::VmFlags

pub struct VmFlags(_);

Represents the kernel flags associated with the virtual memory area. The names of these flags are just those you’ll find in the man page, but in upper case.

Implementations

impl VmFlags

pub const NONE: Self = _

No flags

pub const RD: Self = _

Readable

pub const WR: Self = _

Writable

pub const EX: Self = _

Executable

pub const SH: Self = _

Shared

pub const MR: Self = _

May read

pub const MW: Self = _

May write

pub const ME: Self = _

May execute

pub const MS: Self = _

May share

pub const GD: Self = _

Stack segment grows down

pub const PF: Self = _

Pure PFN range

pub const DW: Self = _

Disable write to the mapped file

pub const LO: Self = _

Pages are locked in memory

pub const IO: Self = _

Memory mapped I/O area

pub const SR: Self = _

Sequential read advise provided

pub const RR: Self = _

Random read provided

pub const DC: Self = _

Do not copy area on fork

pub const DE: Self = _

Do not expand area on remapping

pub const AC: Self = _

Area is accountable

pub const NR: Self = _

Swap space is not reserved for the area

pub const HT: Self = _

Area uses huge TLB pages

pub const SF: Self = _

Perform synchronous page faults (since Linux 4.15)

pub const NL: Self = _

Non-linear mapping (removed in Linux 4.0)

pub const AR: Self = _

Architecture specific flag

pub const WF: Self = _

Wipe on fork (since Linux 4.14)

pub const DD: Self = _

Do not include area into core dump

pub const SD: Self = _

Soft-dirty flag (since Linux 3.13)

pub const MM: Self = _

Mixed map area

pub const HG: Self = _

Huge page advise flag

pub const NH: Self = _

No-huge page advise flag

pub const MG: Self = _

Mergeable advise flag

pub const UM: Self = _

Userfaultfd missing pages tracking (since Linux 4.3)

pub const UW: Self = _

Userfaultfd wprotect pages tracking (since Linux 4.3)

impl VmFlags

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

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).

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.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

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.

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.

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.

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.

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.

impl VmFlags

pub const fn iter(&self) -> Iter<VmFlags>

Iterate over enabled flag values.

pub const fn iter_names(&self) -> IterNames<VmFlags>

Iterate over enabled flag values with their stringified names.

Trait Implementations

impl Binary for VmFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd<VmFlags> for VmFlags

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

type Output = VmFlags

The resulting type after applying the & operator.

impl BitAndAssign<VmFlags> for VmFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<VmFlags> for VmFlags

fn bitor(self, other: VmFlags) -> Self

Returns the union of the two sets of flags.

type Output = VmFlags

The resulting type after applying the | operator.

impl BitOrAssign<VmFlags> for VmFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<VmFlags> for VmFlags

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

type Output = VmFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<VmFlags> for VmFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for VmFlags

fn clone(&self) -> VmFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VmFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for VmFlags

fn default() -> VmFlags

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VmFlags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<VmFlags> for VmFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for VmFlags

const FLAGS: &'static [Flag<VmFlags>] = _

The set of available flags and their names.

type Bits = u32

The underlying storage type.

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

fn from_bits_retain(bits: u32) -> VmFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

fn empty() -> Self

Returns an empty set of flags.

fn all() -> Self

Returns the set containing all flags.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

fn from_name(name: &str) -> Option<Self>

Get the flag for a particular name.

fn iter(&self) -> Iter<Self>

Iterate over enabled flag values.

fn iter_names(&self) -> IterNames<Self>

Iterate over the raw names and bits for enabled flag values.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

fn intersects(&self, other: Self) -> boolwhere Self: Sized,

Returns true if there are flags common to both self and other.

fn contains(&self, other: Self) -> boolwhere Self: Sized,

Returns true if all of the flags in other are contained within self.

fn insert(&mut self, other: Self)where Self: Sized,

Inserts the specified flags in-place.

fn remove(&mut self, other: Self)where Self: Sized,

Removes the specified flags in-place.

fn toggle(&mut self, other: Self)where Self: Sized,

Toggles the specified flags in-place.

fn set(&mut self, other: Self, value: bool)where Self: Sized,

Inserts or removes the specified flags depending on the passed value.

fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

fn complement(self) -> Self

Returns the complement of this set of flags.

impl FromIterator<VmFlags> for VmFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for VmFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for VmFlags

type Item = VmFlags

The type of the elements being iterated over.

type IntoIter = Iter<VmFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for VmFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for VmFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = VmFlags

The resulting type after applying the ! operator.

impl Octal for VmFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for VmFlags

fn cmp(&self, other: &VmFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<VmFlags> for VmFlags

fn eq(&self, other: &VmFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<VmFlags> for VmFlags

fn partial_cmp(&self, other: &VmFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PublicFlags for VmFlags

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Serialize for VmFlags

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<VmFlags> for VmFlags

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

type Output = VmFlags

The resulting type after applying the - operator.

impl SubAssign<VmFlags> for VmFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for VmFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for VmFlags

impl Eq for VmFlags

impl StructuralEq for VmFlags

impl StructuralPartialEq for VmFlags