Struct uefi_raw::table::boot::MemoryAttribute
source · #[repr(transparent)]pub struct MemoryAttribute(_);
Expand description
Flags describing the capabilities of a memory range.
Implementations§
source§impl MemoryAttribute
impl MemoryAttribute
sourcepub const UNCACHEABLE: Self = _
pub const UNCACHEABLE: Self = _
Supports marking as uncacheable.
sourcepub const WRITE_COMBINE: Self = _
pub const WRITE_COMBINE: Self = _
Supports write-combining.
sourcepub const WRITE_THROUGH: Self = _
pub const WRITE_THROUGH: Self = _
Supports write-through.
sourcepub const WRITE_BACK: Self = _
pub const WRITE_BACK: Self = _
Support write-back.
sourcepub const UNCACHABLE_EXPORTED: Self = _
pub const UNCACHABLE_EXPORTED: Self = _
Supports marking as uncacheable, exported and supports the “fetch and add” semaphore mechanism.
sourcepub const WRITE_PROTECT: Self = _
pub const WRITE_PROTECT: Self = _
Supports write-protection.
sourcepub const READ_PROTECT: Self = _
pub const READ_PROTECT: Self = _
Supports read-protection.
sourcepub const EXECUTE_PROTECT: Self = _
pub const EXECUTE_PROTECT: Self = _
Supports disabling code execution.
sourcepub const NON_VOLATILE: Self = _
pub const NON_VOLATILE: Self = _
Persistent memory.
sourcepub const MORE_RELIABLE: Self = _
pub const MORE_RELIABLE: Self = _
This memory region is more reliable than other memory.
sourcepub const SPECIAL_PURPOSE: Self = _
pub const SPECIAL_PURPOSE: Self = _
This memory is earmarked for specific purposes such as for specific device drivers or applications. This serves as a hint to the OS to avoid this memory for core OS data or code that cannot be relocated.
sourcepub const CPU_CRYPTO: Self = _
pub const CPU_CRYPTO: Self = _
This memory region is capable of being protected with the CPU’s memory cryptography capabilities.
sourcepub const RUNTIME: Self = _
pub const RUNTIME: Self = _
This memory must be mapped by the OS when a runtime service is called.
sourcepub const ISA_VALID: Self = _
pub const ISA_VALID: Self = _
This memory region is described with additional ISA-specific memory
attributes as specified in MemoryAttribute::ISA_MASK
.
sourcepub const ISA_MASK: Self = _
pub const ISA_MASK: Self = _
These bits are reserved for describing optional ISA-specific cache-
ability attributes that are not covered by the standard UEFI Memory
Attribute cacheability bits such as UNCACHEABLE
, WRITE_COMBINE
,
WRITE_THROUGH
, WRITE_BACK
, and UNCACHEABLE_EXPORTED
.
See Section 2.3 “Calling Conventions” in the UEFI Specification for further information on each ISA that takes advantage of this.
source§impl MemoryAttribute
impl MemoryAttribute
sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u64) -> Self
pub const fn from_bits_retain(bits: u64) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
sourcepub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
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
.
source§impl MemoryAttribute
impl MemoryAttribute
sourcepub const fn iter(&self) -> Iter<MemoryAttribute>
pub const fn iter(&self) -> Iter<MemoryAttribute>
Iterate over enabled flag values.
sourcepub const fn iter_names(&self) -> IterNames<MemoryAttribute>
pub const fn iter_names(&self) -> IterNames<MemoryAttribute>
Iterate over enabled flag values with their stringified names.
Trait Implementations§
source§impl Binary for MemoryAttribute
impl Binary for MemoryAttribute
source§impl BitAnd<MemoryAttribute> for MemoryAttribute
impl BitAnd<MemoryAttribute> for MemoryAttribute
source§impl BitAndAssign<MemoryAttribute> for MemoryAttribute
impl BitAndAssign<MemoryAttribute> for MemoryAttribute
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<MemoryAttribute> for MemoryAttribute
impl BitOr<MemoryAttribute> for MemoryAttribute
source§fn bitor(self, other: MemoryAttribute) -> Self
fn bitor(self, other: MemoryAttribute) -> Self
Returns the union of the two sets of flags.
§type Output = MemoryAttribute
type Output = MemoryAttribute
|
operator.source§impl BitOrAssign<MemoryAttribute> for MemoryAttribute
impl BitOrAssign<MemoryAttribute> for MemoryAttribute
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<MemoryAttribute> for MemoryAttribute
impl BitXor<MemoryAttribute> for MemoryAttribute
source§impl BitXorAssign<MemoryAttribute> for MemoryAttribute
impl BitXorAssign<MemoryAttribute> for MemoryAttribute
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for MemoryAttribute
impl Clone for MemoryAttribute
source§fn clone(&self) -> MemoryAttribute
fn clone(&self) -> MemoryAttribute
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for MemoryAttribute
impl Debug for MemoryAttribute
source§impl Default for MemoryAttribute
impl Default for MemoryAttribute
source§fn default() -> MemoryAttribute
fn default() -> MemoryAttribute
source§impl Extend<MemoryAttribute> for MemoryAttribute
impl Extend<MemoryAttribute> for MemoryAttribute
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 MemoryAttribute
impl Flags for MemoryAttribute
source§const FLAGS: &'static [Flag<MemoryAttribute>] = _
const FLAGS: &'static [Flag<MemoryAttribute>] = _
source§fn from_bits_retain(bits: u64) -> MemoryAttribute
fn from_bits_retain(bits: u64) -> MemoryAttribute
source§fn from_bits(bits: Self::Bits) -> Option<Self>
fn from_bits(bits: Self::Bits) -> Option<Self>
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> 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,
true
if there are flags common to both self
and other
.source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
true
if all of the flags in other
are contained within self
.source§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where Self: Sized,
source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
source§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
source§fn complement(self) -> Self
fn complement(self) -> Self
source§impl FromIterator<MemoryAttribute> for MemoryAttribute
impl FromIterator<MemoryAttribute> for MemoryAttribute
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for MemoryAttribute
impl Hash for MemoryAttribute
source§impl IntoIterator for MemoryAttribute
impl IntoIterator for MemoryAttribute
source§impl LowerHex for MemoryAttribute
impl LowerHex for MemoryAttribute
source§impl Not for MemoryAttribute
impl Not for MemoryAttribute
source§impl Octal for MemoryAttribute
impl Octal for MemoryAttribute
source§impl Ord for MemoryAttribute
impl Ord for MemoryAttribute
source§fn cmp(&self, other: &MemoryAttribute) -> Ordering
fn cmp(&self, other: &MemoryAttribute) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<MemoryAttribute> for MemoryAttribute
impl PartialEq<MemoryAttribute> for MemoryAttribute
source§fn eq(&self, other: &MemoryAttribute) -> bool
fn eq(&self, other: &MemoryAttribute) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<MemoryAttribute> for MemoryAttribute
impl PartialOrd<MemoryAttribute> for MemoryAttribute
source§fn partial_cmp(&self, other: &MemoryAttribute) -> Option<Ordering>
fn partial_cmp(&self, other: &MemoryAttribute) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PublicFlags for MemoryAttribute
impl PublicFlags for MemoryAttribute
source§impl Sub<MemoryAttribute> for MemoryAttribute
impl Sub<MemoryAttribute> for MemoryAttribute
source§impl SubAssign<MemoryAttribute> for MemoryAttribute
impl SubAssign<MemoryAttribute> for MemoryAttribute
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.