Struct Par 

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

PAR system register value.

Implementations

impl Par

pub const F: Self

F bit.

pub const SS: Self

SS bit.

pub const FS_5: Self

FS[5] bit.

pub const S2WLK: Self

S2WLK bit.

pub const FSTAGE: Self

FSTAGE bit.

pub const NS: Self

NS bit.

pub const NOS: Self

NOS bit.

pub const LPAE: Self

LPAE bit.

impl Par

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

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

Convert from a bits value.

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

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

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.

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

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

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.

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

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

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.

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

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

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

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

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

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

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

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

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.

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

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

pub const fn complement(self) -> Self

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

impl Par

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

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

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.

impl Par

pub const F_SHIFT: u32 = 0

Offset of the F field.

pub const FST_SHIFT: u32 = 1

Offset of the FST field.

pub const FST_MASK: u64 = 0b111111

Mask for the FST field.

pub const FS_4_0_SHIFT: u32 = 1

Offset of the FS[4:0] field.

pub const FS_4_0_MASK: u64 = 0b11111

Mask for the FS[4:0] field.

pub const SS_SHIFT: u32 = 1

Offset of the SS field.

pub const OUTER_1_0_SHIFT: u32 = 2

Offset of the Outer[1:0] field.

pub const OUTER_1_0_MASK: u64 = 0b11

Mask for the Outer[1:0] field.

pub const INNER_2_0_SHIFT: u32 = 4

Offset of the Inner[2:0] field.

pub const INNER_2_0_MASK: u64 = 0b111

Mask for the Inner[2:0] field.

pub const FS_5_SHIFT: u32 = 6

Offset of the FS[5] field.

pub const S2WLK_SHIFT: u32 = 8

Offset of the S2WLK field.

pub const FSTAGE_SHIFT: u32 = 9

Offset of the FSTAGE field.

pub const NS_SHIFT: u32 = 9

Offset of the NS field.

pub const NOS_SHIFT: u32 = 10

Offset of the NOS field.

pub const LPAE_SHIFT: u32 = 11

Offset of the LPAE field.

pub const ATTR_SHIFT: u32 = 56

Offset of the ATTR field.

pub const ATTR_MASK: u64 = 0b11111111

Mask for the ATTR field.

pub const fn fst(self) -> u8

Returns the value of the FST field.

pub const fn set_fst(&mut self, value: u8)

Sets the value of the FST field.

pub const fn with_fst(self, value: u8) -> Self

Returns a copy with the FST field set to the given value.

pub const fn fs_4_0(self) -> u8

Returns the value of the FS[4:0] field.

pub const fn set_fs_4_0(&mut self, value: u8)

Sets the value of the FS[4:0] field.

pub const fn with_fs_4_0(self, value: u8) -> Self

Returns a copy with the FS[4:0] field set to the given value.

pub const fn outer_1_0(self) -> u8

Returns the value of the Outer[1:0] field.

pub const fn set_outer_1_0(&mut self, value: u8)

Sets the value of the Outer[1:0] field.

pub const fn with_outer_1_0(self, value: u8) -> Self

Returns a copy with the Outer[1:0] field set to the given value.

pub const fn inner_2_0(self) -> u8

Returns the value of the Inner[2:0] field.

pub const fn set_inner_2_0(&mut self, value: u8)

Sets the value of the Inner[2:0] field.

pub const fn with_inner_2_0(self, value: u8) -> Self

Returns a copy with the Inner[2:0] field set to the given value.

pub const fn attr(self) -> u8

Returns the value of the ATTR field.

pub const fn set_attr(&mut self, value: u8)

Sets the value of the ATTR field.

pub const fn with_attr(self, value: u8) -> Self

Returns a copy with the ATTR field set to the given value.

Trait Implementations

impl Binary for Par

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

Formats the value using the given formatter.

impl BitAnd for Par

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

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

type Output = Par

The resulting type after applying the & operator.

impl BitAndAssign for Par

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for Par

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

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

type Output = Par

The resulting type after applying the | operator.

impl BitOrAssign for Par

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for Par

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

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

type Output = Par

The resulting type after applying the ^ operator.

impl BitXorAssign for Par

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for Par

fn clone(&self) -> Par

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Par

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

Formats the value using the given formatter.

impl Default for Par

fn default() -> Par

Returns the “default value” for a type.

impl Extend<Par> for Par

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

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 Par

const FLAGS: &'static [Flag<Par>]

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

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 known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are 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 iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

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 truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

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 clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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 FromIterator<Par> for Par

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

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

impl IntoIterator for Par

type Item = Par

The type of the elements being iterated over.

type IntoIter = Iter<Par>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Par

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

Formats the value using the given formatter.

impl Not for Par

fn not(self) -> Self

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

type Output = Par

The resulting type after applying the ! operator.

impl Octal for Par

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

Formats the value using the given formatter.

impl PartialEq for Par

fn eq(&self, other: &Par) -> 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 PublicFlags for Par

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Sub for Par

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.

type Output = Par

The resulting type after applying the - operator.

impl SubAssign for Par

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.

impl UpperHex for Par

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

Formats the value using the given formatter.

impl Copy for Par

impl Eq for Par

impl StructuralPartialEq for Par