Struct memory_structs::PhysicalAddress

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

A physical memory address, which is a usize under the hood.

Implementations

impl PhysicalAddress

pub fn new(addr: usize) -> Option<PhysicalAddress>

Creates a new PhysicalAddress, returning an error if the address is not canonical.

This is useful for checking whether an address is valid before using it. For example, on x86_64, virtual addresses are canonical if their upper bits (64:48] are sign-extended from bit 47, and physical addresses are canonical if their upper bits (64:52] are 0.

pub const fn new_canonical(addr: usize) -> PhysicalAddress

Creates a new PhysicalAddress that is guaranteed to be canonical.

pub const fn zero() -> PhysicalAddress

Creates a new PhysicalAddress with a value 0.

pub const fn value(&self) -> usize

Returns the underlying usize value for this PhysicalAddress.

pub const fn frame_offset(&self) -> usize

Returns the offset from the 4K frame boundary specified by this `PhysicalAddress.

For example, for the address 0xFFFF_1578, this will return 0x578, the least significant 12 bits (12:0] of this PhysicalAddress.

Trait Implementations

impl Add<usize> for PhysicalAddress

type Output = PhysicalAddress

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> PhysicalAddress

Performs the + operation.

impl Add<PhysicalAddress> for PhysicalAddress

type Output = PhysicalAddress

The resulting type after applying the + operator.

fn add(self, rhs: PhysicalAddress) -> PhysicalAddress

Performs the + operation.

impl AddAssign<usize> for PhysicalAddress

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl AddAssign<PhysicalAddress> for PhysicalAddress

fn add_assign(&mut self, rhs: PhysicalAddress)

Performs the += operation.

impl Binary for PhysicalAddress

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

Formats the value using the given formatter.

impl BitAnd<PhysicalAddress> for PhysicalAddress

type Output = PhysicalAddress

The resulting type after applying the & operator.

fn bitand(self, rhs: PhysicalAddress) -> PhysicalAddress

Performs the & operation.

impl BitAndAssign<PhysicalAddress> for PhysicalAddress

fn bitand_assign(&mut self, rhs: PhysicalAddress)

Performs the &= operation.

impl BitOr<PhysicalAddress> for PhysicalAddress

type Output = PhysicalAddress

The resulting type after applying the | operator.

fn bitor(self, rhs: PhysicalAddress) -> PhysicalAddress

Performs the | operation.

impl BitOrAssign<PhysicalAddress> for PhysicalAddress

fn bitor_assign(&mut self, rhs: PhysicalAddress)

Performs the |= operation.

impl BitXor<PhysicalAddress> for PhysicalAddress

type Output = PhysicalAddress

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: PhysicalAddress) -> PhysicalAddress

Performs the ^ operation.

impl BitXorAssign<PhysicalAddress> for PhysicalAddress

fn bitxor_assign(&mut self, rhs: PhysicalAddress)

Performs the ^= operation.

impl Clone for PhysicalAddress

fn clone(&self) -> PhysicalAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PhysicalAddress

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

Formats the value using the given formatter.

impl Default for PhysicalAddress

fn default() -> PhysicalAddress

Returns the “default value” for a type.

impl Display for PhysicalAddress

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

Formats the value using the given formatter.

impl Hash for PhysicalAddress

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

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 Into<usize> for PhysicalAddress

fn into(self) -> usize

Converts this type into the (usually inferred) input type.

impl LowerHex for PhysicalAddress

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

Formats the value using the given formatter.

impl Octal for PhysicalAddress

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

Formats the value using the given formatter.

impl Ord for PhysicalAddress

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<PhysicalAddress> for PhysicalAddress

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

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

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.

impl PartialOrd<PhysicalAddress> for PhysicalAddress

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Pointer for PhysicalAddress

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

Formats the value using the given formatter.

impl Sub<usize> for PhysicalAddress

type Output = PhysicalAddress

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> PhysicalAddress

Performs the - operation.

impl Sub<PhysicalAddress> for PhysicalAddress

type Output = PhysicalAddress

The resulting type after applying the - operator.

fn sub(self, rhs: PhysicalAddress) -> PhysicalAddress

Performs the - operation.

impl SubAssign<usize> for PhysicalAddress

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl SubAssign<PhysicalAddress> for PhysicalAddress

fn sub_assign(&mut self, rhs: PhysicalAddress)

Performs the -= operation.

impl UpperHex for PhysicalAddress

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

Formats the value using the given formatter.

impl Copy for PhysicalAddress

impl Eq for PhysicalAddress

impl FromBytes for PhysicalAddress

impl StructuralEq for PhysicalAddress

impl StructuralPartialEq for PhysicalAddress