Struct x86_64::addr::PhysAddr

source ·
pub struct PhysAddr(/* private fields */);
Expand description

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§

source§

impl PhysAddr

source

pub const fn new(addr: u64) -> Self

Creates a new physical address.

§Panics

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

source

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

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

source

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.

source

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

Tries to create a new physical address.

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

source

pub const fn zero() -> PhysAddr

Creates a physical address that points to 0.

source

pub const fn as_u64(self) -> u64

Converts the address to an u64.

source

pub const fn is_null(self) -> bool

Convenience method for checking if a physical address is null.

source

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.

§Panics

This function panics if the resulting address has a bit in the range 52 to 64 set.

source

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.

source

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

Checks whether the physical address has the demanded alignment.

Trait Implementations§

source§

impl Add<u64> for PhysAddr

§

type Output = PhysAddr

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl Add<usize> for PhysAddr

Available on 64-bit only.
§

type Output = PhysAddr

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl AddAssign<u64> for PhysAddr

source§

fn add_assign(&mut self, rhs: u64)

Performs the += operation. Read more
source§

impl AddAssign<usize> for PhysAddr

Available on 64-bit only.
source§

fn add_assign(&mut self, rhs: usize)

Performs the += operation. Read more
source§

impl Binary for PhysAddr

source§

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

Formats the value using the given formatter.
source§

impl Clone for PhysAddr

source§

fn clone(&self) -> PhysAddr

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PhysAddr

source§

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

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

impl Hash for PhysAddr

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl LowerHex for PhysAddr

source§

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

Formats the value using the given formatter.
source§

impl Octal for PhysAddr

source§

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

Formats the value using the given formatter.
source§

impl Ord for PhysAddr

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq for PhysAddr

source§

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

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

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

impl PartialOrd for PhysAddr

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Pointer for PhysAddr

source§

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

Formats the value using the given formatter.
source§

impl Sub<u64> for PhysAddr

§

type Output = PhysAddr

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl Sub<usize> for PhysAddr

Available on 64-bit only.
§

type Output = PhysAddr

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl Sub for PhysAddr

§

type Output = u64

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl SubAssign<u64> for PhysAddr

source§

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation. Read more
source§

impl SubAssign<usize> for PhysAddr

Available on 64-bit only.
source§

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation. Read more
source§

impl UpperHex for PhysAddr

source§

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

Formats the value using the given formatter.
source§

impl Copy for PhysAddr

source§

impl Eq for PhysAddr

source§

impl StructuralPartialEq for PhysAddr

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

§

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

§

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.