Struct procfs::process::VmFlags

source ·
pub struct VmFlags(/* private fields */);
Expand description

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§

source§

impl VmFlags

source

pub const NONE: VmFlags = _

No flags

source

pub const RD: VmFlags = _

Readable

source

pub const WR: VmFlags = _

Writable

source

pub const EX: VmFlags = _

Executable

source

pub const SH: VmFlags = _

Shared

source

pub const MR: VmFlags = _

May read

source

pub const MW: VmFlags = _

May write

source

pub const ME: VmFlags = _

May execute

source

pub const MS: VmFlags = _

May share

source

pub const GD: VmFlags = _

Stack segment grows down

source

pub const PF: VmFlags = _

Pure PFN range

source

pub const DW: VmFlags = _

Disable write to the mapped file

source

pub const LO: VmFlags = _

Pages are locked in memory

source

pub const IO: VmFlags = _

Memory mapped I/O area

source

pub const SR: VmFlags = _

Sequential read advise provided

source

pub const RR: VmFlags = _

Random read provided

source

pub const DC: VmFlags = _

Do not copy area on fork

source

pub const DE: VmFlags = _

Do not expand area on remapping

source

pub const AC: VmFlags = _

Area is accountable

source

pub const NR: VmFlags = _

Swap space is not reserved for the area

source

pub const HT: VmFlags = _

Area uses huge TLB pages

source

pub const SF: VmFlags = _

Perform synchronous page faults (since Linux 4.15)

source

pub const NL: VmFlags = _

Non-linear mapping (removed in Linux 4.0)

source

pub const AR: VmFlags = _

Architecture specific flag

source

pub const WF: VmFlags = _

Wipe on fork (since Linux 4.14)

source

pub const DD: VmFlags = _

Do not include area into core dump

source

pub const SD: VmFlags = _

Soft-dirty flag (since Linux 3.13)

source

pub const MM: VmFlags = _

Mixed map area

source

pub const HG: VmFlags = _

Huge page advise flag

source

pub const NH: VmFlags = _

No-huge page advise flag

source

pub const MG: VmFlags = _

Mergeable advise flag

source

pub const UM: VmFlags = _

Userfaultfd missing pages tracking (since Linux 4.3)

source

pub const UW: VmFlags = _

Userfaultfd wprotect pages tracking (since Linux 4.3)

source§

impl VmFlags

source

pub const fn empty() -> VmFlags

Get a flags value with all bits unset.

source

pub const fn all() -> VmFlags

Get a flags value with all known bits set.

source

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

source

pub const fn from_bits(bits: u32) -> Option<VmFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

source

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

Convert from a bits value, unsetting any unknown bits.

source

pub const fn from_bits_retain(bits: u32) -> VmFlags

Convert from a bits value exactly.

source

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

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.

source

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

source

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

source

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

Whether any set bits in a source flags value are also set in a target flags value.

source

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

Whether all set bits in a source flags value are also set in a target flags value.

source

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

The bitwise or (|) of the bits in two flags values.

source

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

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.

source

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

The bitwise exclusive-or (^) of the bits in two flags values.

source

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

Call insert when value is true or remove when value is false.

source

pub const fn intersection(self, other: VmFlags) -> VmFlags

The bitwise and (&) of the bits in two flags values.

source

pub const fn union(self, other: VmFlags) -> VmFlags

The bitwise or (|) of the bits in two flags values.

source

pub const fn difference(self, other: VmFlags) -> VmFlags

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

pub const fn symmetric_difference(self, other: VmFlags) -> VmFlags

The bitwise exclusive-or (^) of the bits in two flags values.

source

pub const fn complement(self) -> VmFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

source§

impl VmFlags

source

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

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.

source

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

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 VmFlags

source§

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

Formats the value using the given formatter.
source§

impl BitAnd for VmFlags

source§

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

The bitwise and (&) of the bits in two flags values.

§

type Output = VmFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign for VmFlags

source§

fn bitand_assign(&mut self, other: VmFlags)

The bitwise and (&) of the bits in two flags values.

source§

impl BitOr for VmFlags

source§

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

The bitwise or (|) of the bits in two flags values.

§

type Output = VmFlags

The resulting type after applying the | operator.
source§

impl BitOrAssign for VmFlags

source§

fn bitor_assign(&mut self, other: VmFlags)

The bitwise or (|) of the bits in two flags values.

source§

impl BitXor for VmFlags

source§

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

The bitwise exclusive-or (^) of the bits in two flags values.

§

type Output = VmFlags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for VmFlags

source§

fn bitxor_assign(&mut self, other: VmFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

source§

impl Clone for VmFlags

source§

fn clone(&self) -> VmFlags

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for VmFlags

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for VmFlags

source§

fn default() -> VmFlags

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Extend<VmFlags> for VmFlags

source§

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

The bitwise or (|) of the bits in each flags value.

source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl Flags for VmFlags

source§

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

The set of defined flags.
§

type Bits = u32

The underlying bits type.
source§

fn bits(&self) -> u32

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u32) -> VmFlags

Convert from a bits value exactly.
source§

fn empty() -> Self

Get a flags value with all bits unset.
source§

fn all() -> Self

Get a flags value with all known bits set.
source§

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

Convert from a bits value. Read more
source§

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

Convert from a bits value, unsetting any unknown bits.
source§

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

Get a flags value with the bits of a flag with the given name set. Read more
source§

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

Yield a set of contained flags values. Read more
source§

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

Yield a set of contained named flags values. Read more
source§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
source§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
source§

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

Whether any set bits in a source flags value are also set in a target flags value.
source§

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

Whether all set bits in a source flags value are also set in a target flags value.
source§

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

The bitwise or (|) of the bits in two flags values.
source§

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

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

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

The bitwise exclusive-or (^) of the bits in two flags values.
source§

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

Call Flags::insert when value is true or Flags::remove when value is false.
source§

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

The bitwise and (&) of the bits in two flags values.
source§

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

The bitwise or (|) of the bits in two flags values.
source§

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

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

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

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
source§

impl FromIterator<VmFlags> for VmFlags

source§

fn from_iter<T>(iterator: T) -> VmFlagswhere T: IntoIterator<Item = VmFlags>,

The bitwise or (|) of the bits in each flags value.

source§

impl Hash for VmFlags

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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?
source§

fn into_iter(self) -> <VmFlags as IntoIterator>::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for VmFlags

source§

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

Formats the value using the given formatter.
source§

impl Not for VmFlags

source§

fn not(self) -> VmFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

§

type Output = VmFlags

The resulting type after applying the ! operator.
source§

impl Octal for VmFlags

source§

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

Formats the value using the given formatter.
source§

impl Ord for VmFlags

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq for VmFlags

source§

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

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

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.
source§

impl PartialOrd for VmFlags

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Serialize for VmFlags

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Sub for VmFlags

source§

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

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.

§

type Output = VmFlags

The resulting type after applying the - operator.
source§

impl SubAssign for VmFlags

source§

fn sub_assign(&mut self, other: VmFlags)

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 VmFlags

source§

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

Formats the value using the given formatter.
source§

impl Copy for VmFlags

source§

impl Eq for VmFlags

source§

impl StructuralEq for VmFlags

source§

impl StructuralPartialEq for VmFlags

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,