Struct PTF

pub struct PTF(/* private fields */);

Available on x86-64 only.

Possible flags for a page table entry.

Implementations

impl PageTableFlags

pub const PRESENT: PageTableFlags = _

Specifies whether the mapped frame or page table is loaded in memory.

pub const WRITABLE: PageTableFlags = _

Controls whether writes to the mapped frames are allowed.

If this bit is unset in a level 1 page table entry, the mapped frame is read-only. If this bit is unset in a higher level page table entry the complete range of mapped pages is read-only.

pub const USER_ACCESSIBLE: PageTableFlags = _

Controls whether accesses from userspace (i.e. ring 3) are permitted.

pub const WRITE_THROUGH: PageTableFlags = _

If this bit is set, a “write-through” policy is used for the cache, else a “write-back” policy is used.

pub const NO_CACHE: PageTableFlags = _

Disables caching for the pointed entry is cacheable.

pub const ACCESSED: PageTableFlags = _

Set by the CPU when the mapped frame or page table is accessed.

pub const DIRTY: PageTableFlags = _

Set by the CPU on a write to the mapped frame.

pub const HUGE_PAGE: PageTableFlags = _

Specifies that the entry maps a huge frame instead of a page table. Only allowed in P2 or P3 tables.

pub const GLOBAL: PageTableFlags = _

Indicates that the mapping is present in all address spaces, so it isn’t flushed from the TLB on an address space switch.

pub const BIT_9: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_10: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_11: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_52: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_53: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_54: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_55: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_56: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_57: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_58: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_59: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_60: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_61: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_62: PageTableFlags = _

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const NO_EXECUTE: PageTableFlags = _

Forbid code execution from the mapped frames.

Can be only used when the no-execute page protection feature is enabled in the EFER register.

impl PageTableFlags

pub const fn empty() -> PageTableFlags

Get a flags value with all bits unset.

pub const fn all() -> PageTableFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

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

pub const fn from_bits(bits: u64) -> Option<PageTableFlags>

Convert from a bits value.

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

pub const fn from_bits_truncate(bits: u64) -> PageTableFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> PageTableFlags

Convert from a bits value exactly.

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

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.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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.

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

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

pub const fn complement(self) -> PageTableFlags

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

impl PageTableFlags

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

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.

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

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

impl Binary for PageTableFlags

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

Formats the value using the given formatter.

impl BitAnd for PageTableFlags

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

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

type Output = PageTableFlags

The resulting type after applying the & operator.

impl BitAndAssign for PageTableFlags

fn bitand_assign(&mut self, other: PageTableFlags)

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

impl BitOr for PageTableFlags

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

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

type Output = PageTableFlags

The resulting type after applying the | operator.

impl BitOrAssign for PageTableFlags

fn bitor_assign(&mut self, other: PageTableFlags)

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

impl BitXor for PageTableFlags

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

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

type Output = PageTableFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for PageTableFlags

fn bitxor_assign(&mut self, other: PageTableFlags)

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

impl Clone for PageTableFlags

fn clone(&self) -> PageTableFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PageTableFlags

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

Formats the value using the given formatter.

impl Extend<PageTableFlags> for PageTableFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = PageTableFlags>,

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

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 PageTableFlags

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

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> PageTableFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

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

Convert from a bits value.

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

Convert from a bits value, unsetting any unknown bits.

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

Get a flags value with the bits of a flag with the given name set.

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

Yield a set of contained flags values.

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

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

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

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

where Self: Sized,

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

fn insert(&mut self, other: Self)

where Self: Sized,

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

fn remove(&mut self, other: Self)

where Self: Sized,

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

fn toggle(&mut self, other: Self)

where Self: Sized,

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

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.

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

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

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

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

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

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

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

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

fn complement(self) -> Self

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

impl From<MappingFlags> for PTF

fn from(f: MappingFlags) -> Self

Converts to this type from the input type.

impl From<PageTableFlags> for MappingFlags

fn from(f: PTF) -> Self

Converts to this type from the input type.

impl FromIterator<PageTableFlags> for PageTableFlags

fn from_iter<T>(iterator: T) -> PageTableFlags

where T: IntoIterator<Item = PageTableFlags>,

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

impl Hash for PageTableFlags

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

where __H: Hasher,

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 PageTableFlags

type Item = PageTableFlags

The type of the elements being iterated over.

type IntoIter = Iter<PageTableFlags>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for PageTableFlags

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

Formats the value using the given formatter.

impl Not for PageTableFlags

fn not(self) -> PageTableFlags

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

type Output = PageTableFlags

The resulting type after applying the ! operator.

impl Octal for PageTableFlags

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

Formats the value using the given formatter.

impl Ord for PageTableFlags

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PageTableFlags

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for PageTableFlags

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub for PageTableFlags

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

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 = PageTableFlags

The resulting type after applying the - operator.

impl SubAssign for PageTableFlags

fn sub_assign(&mut self, other: PageTableFlags)

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.

impl UpperHex for PageTableFlags

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

Formats the value using the given formatter.

impl Copy for PageTableFlags

impl Eq for PageTableFlags

impl StructuralPartialEq for PageTableFlags