page_table_entry::aarch64

Struct DescriptorAttr

Source
pub struct DescriptorAttr(/* private fields */);
Available on AArch64 only.
Expand description

Memory attribute fields in the VMSAv8-64 translation table format descriptors.

Implementations§

Source§

impl DescriptorAttr

Source

pub const VALID: Self = _

Whether the descriptor is valid.

Source

pub const NON_BLOCK: Self = _

The descriptor gives the address of the next level of translation table or 4KB page. (not a 2M, 1G block)

Source

pub const ATTR_INDX: Self = _

Memory attributes index field.

Source

pub const NS: Self = _

Non-secure bit. For memory accesses from Secure state, specifies whether the output address is in Secure or Non-secure memory.

Source

pub const AP_EL0: Self = _

Access permission: accessable at EL0.

Source

pub const AP_RO: Self = _

Access permission: read-only.

Source

pub const INNER: Self = _

Shareability: Inner Shareable (otherwise Outer Shareable).

Source

pub const SHAREABLE: Self = _

Shareability: Inner or Outer Shareable (otherwise Non-shareable).

Source

pub const AF: Self = _

The Access flag.

Source

pub const NG: Self = _

The not global bit.

Source

pub const CONTIGUOUS: Self = _

Indicates that 16 adjacent translation table entries point to contiguous memory regions.

Source

pub const PXN: Self = _

The Privileged execute-never field.

Source

pub const UXN: Self = _

The Execute-never or Unprivileged execute-never field.

Source

pub const PXN_TABLE: Self = _

PXN limit for subsequent levels of lookup.

Source

pub const XN_TABLE: Self = _

XN limit for subsequent levels of lookup.

Source

pub const AP_NO_EL0_TABLE: Self = _

Access permissions limit for subsequent levels of lookup: access at EL0 not permitted.

Source

pub const AP_NO_WRITE_TABLE: Self = _

Access permissions limit for subsequent levels of lookup: write access not permitted.

Source

pub const NS_TABLE: Self = _

For memory accesses from Secure state, specifies the Security state for subsequent levels of lookup.

Source§

impl DescriptorAttr

Source

pub const fn empty() -> Self

Get a flags value with all bits unset.

Source

pub const fn all() -> Self

Get a flags value with all known bits set.

Source

pub const fn bits(&self) -> u64

Get the underlying bits value.

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

Source

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

Convert from a bits value.

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

Source

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

Convert from a bits value, unsetting any unknown bits.

Source

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

Convert from a bits value exactly.

Source

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.

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: Self) -> 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: Self) -> 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: Self)

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

Source

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.

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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.

Source

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

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

Source

pub const fn complement(self) -> Self

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

Source§

impl DescriptorAttr

Source

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

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<DescriptorAttr>

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.

Source§

impl DescriptorAttr

Source

pub const fn from_mem_attr(idx: MemAttr) -> Self

Constructs a descriptor from the memory index, leaving the other fields empty.

Source

pub const fn mem_attr(&self) -> Option<MemAttr>

Returns the memory attribute index field.

Trait Implementations§

Source§

impl Binary for DescriptorAttr

Source§

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

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

impl BitAnd for DescriptorAttr

Source§

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

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

Source§

type Output = DescriptorAttr

The resulting type after applying the & operator.
Source§

impl BitAndAssign for DescriptorAttr

Source§

fn bitand_assign(&mut self, other: Self)

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

Source§

impl BitOr for DescriptorAttr

Source§

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

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

Source§

type Output = DescriptorAttr

The resulting type after applying the | operator.
Source§

impl BitOrAssign for DescriptorAttr

Source§

fn bitor_assign(&mut self, other: Self)

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

Source§

impl BitXor for DescriptorAttr

Source§

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

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

Source§

type Output = DescriptorAttr

The resulting type after applying the ^ operator.
Source§

impl BitXorAssign for DescriptorAttr

Source§

fn bitxor_assign(&mut self, other: Self)

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

Source§

impl Debug for DescriptorAttr

Source§

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

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

impl Extend<DescriptorAttr> for DescriptorAttr

Source§

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)

🔬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 DescriptorAttr

Source§

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

The set of defined flags.
Source§

type Bits = u64

The underlying bits type.
Source§

fn bits(&self) -> u64

Get the underlying bits value. Read more
Source§

fn from_bits_retain(bits: u64) -> DescriptorAttr

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

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

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

Yield a set of contained flags values. Read more
§

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

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

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 (&!). Read more
§

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 (&!). Read more
§

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

impl From<DescriptorAttr> for MappingFlags

Source§

fn from(attr: DescriptorAttr) -> Self

Converts to this type from the input type.
Source§

impl From<MappingFlags> for DescriptorAttr

Source§

fn from(flags: MappingFlags) -> Self

Converts to this type from the input type.
Source§

impl FromIterator<DescriptorAttr> for DescriptorAttr

Source§

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

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

Source§

impl IntoIterator for DescriptorAttr

Source§

type Item = DescriptorAttr

The type of the elements being iterated over.
Source§

type IntoIter = Iter<DescriptorAttr>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl LowerHex for DescriptorAttr

Source§

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

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

impl Not for DescriptorAttr

Source§

fn not(self) -> Self

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

Source§

type Output = DescriptorAttr

The resulting type after applying the ! operator.
Source§

impl Octal for DescriptorAttr

Source§

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

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

impl PublicFlags for DescriptorAttr

Source§

type Primitive = u64

The type of the underlying storage.
Source§

type Internal = InternalBitFlags

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

impl Sub for DescriptorAttr

Source§

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

The resulting type after applying the - operator.
Source§

impl SubAssign for DescriptorAttr

Source§

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 DescriptorAttr

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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 T
where 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.