Struct x86_64::addr::PhysAddr

#[repr(transparent)]
pub struct PhysAddr(_);

A 64-bit physical memory address.

This is a wrapper type around an u64, so it is always 8 bytes, even when compiled on non 64-bit systems. The TryFrom trait can be used for performing conversions between u64 and usize.

On x86_64, only the 52 lower bits of a physical address can be used. The top 12 bits need to be zero. This type guarantees that it always represents a valid physical address.

Implementations

impl PhysAddr

pub fn new(addr: u64) -> PhysAddr

Creates a new physical address.

Panics

This function panics if a bit in the range 52 to 64 is set.

pub const fn new_truncate(addr: u64) -> PhysAddr

Creates a new physical address, throwing bits 52..64 away.

pub const unsafe fn new_unsafe(addr: u64) -> PhysAddr

Creates a new physical address, without any checks.

Safety

You must make sure bits 52..64 are zero. This is not checked.

pub fn try_new(addr: u64) -> Result<PhysAddr, PhysAddrNotValid>

Tries to create a new physical address.

Fails if any bits in the range 52 to 64 are set.

pub const fn zero() -> PhysAddr

Creates a physical address that points to 0.

pub const fn as_u64(self) -> u64

Converts the address to an u64.

pub const fn is_null(self) -> bool

Convenience method for checking if a physical address is null.

pub fn align_up<U>(self, align: U) -> Self where
    U: Into<u64>, 

Aligns the physical address upwards to the given alignment.

See the align_up function for more information.

pub fn align_down<U>(self, align: U) -> Self where
    U: Into<u64>, 

Aligns the physical address downwards to the given alignment.

See the align_down function for more information.

pub fn is_aligned<U>(self, align: U) -> bool where
    U: Into<u64>, 

Checks whether the physical address has the demanded alignment.

Trait Implementations

impl Add<u64> for PhysAddr

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl Add<usize> for PhysAddr

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self::Output

Performs the + operation.

impl AddAssign<u64> for PhysAddr

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl AddAssign<usize> for PhysAddr

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Binary for PhysAddr

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

Formats the value using the given formatter.

impl Clone for PhysAddr

fn clone(&self) -> PhysAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PhysAddr

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

Formats the value using the given formatter.

impl LowerHex for PhysAddr

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

Formats the value using the given formatter.

impl Octal for PhysAddr

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

Formats the value using the given formatter.

impl Ord for PhysAddr

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<PhysAddr> for PhysAddr

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

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

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

This method tests for !=.

impl PartialOrd<PhysAddr> for PhysAddr

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 PhysAddr

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

Formats the value using the given formatter.

impl Sub<PhysAddr> for PhysAddr

type Output = u64

The resulting type after applying the - operator.

fn sub(self, rhs: PhysAddr) -> Self::Output

Performs the - operation.

impl Sub<u64> for PhysAddr

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> Self::Output

Performs the - operation.

impl Sub<usize> for PhysAddr

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Self::Output

Performs the - operation.

impl SubAssign<u64> for PhysAddr

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl SubAssign<usize> for PhysAddr

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl UpperHex for PhysAddr

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

Formats the value using the given formatter.

impl Copy for PhysAddr

impl Eq for PhysAddr

impl StructuralEq for PhysAddr

impl StructuralPartialEq for PhysAddr