Struct PhysAddr

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

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 const unsafe fn new_unsafe(addr: u64) -> PhysAddr

Creates a new address, without any checks.

Safety

If addr does not comply with the platforms requirements for this address type, this can lead to UB in functions relying on the compliance or when using the requirements.

pub const fn is_null(self) -> bool

Convenience method for checking if an address is null.

pub const fn zero() -> PhysAddr

Creates an address that points to 0.

pub const fn as_u64(self) -> u64

Converts the address to an u64.

impl PhysAddr

pub const 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 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 as_usize(&self) -> usize

Trait Implementations

impl Add<u64> for PhysAddr

type Output = PhysAddr

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> <PhysAddr as Add<u64>>::Output

Performs the + operation.

impl Add<usize> for PhysAddr

type Output = PhysAddr

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> <PhysAddr as Add<usize>>::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 Align<u64> for PhysAddr

fn align_down(self, align: u64) -> PhysAddr

Align address downwards.

fn align_up(self, align: u64) -> PhysAddr

Align address upwards.

fn is_aligned_to(self, align: A) -> bool

Checks whether the address has the demanded alignment.

impl Binary for PhysAddr

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

Formats the value using the given formatter.

impl BitAnd<u64> for PhysAddr

type Output = u64

The resulting type after applying the & operator.

fn bitand(self, rhs: u64) -> <PhysAddr as BitAnd<u64>>::Output

Performs the & operation.

impl BitAndAssign<u64> for PhysAddr

fn bitand_assign(&mut self, rhs: u64)

Performs the &= operation.

impl BitOr<u64> for PhysAddr

type Output = u64

The resulting type after applying the | operator.

fn bitor(self, rhs: u64) -> <PhysAddr as BitOr<u64>>::Output

Performs the | operation.

impl BitOrAssign<u64> for PhysAddr

fn bitor_assign(&mut self, rhs: u64)

Performs the |= operation.

impl BitXor<u64> for PhysAddr

type Output = u64

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: u64) -> <PhysAddr as BitXor<u64>>::Output

Performs the ^ operation.

impl BitXorAssign<u64> for PhysAddr

fn bitxor_assign(&mut self, rhs: u64)

Performs the ^= operation.

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<(), Error>

Formats the value using the given formatter.

impl From<&PhysAddr> for PhysAddr

fn from(addr: &PhysAddr) -> PhysAddr

Converts to this type from the input type.

impl From<PhysAddr> for PhysAddr

fn from(addr: PhysAddr) -> PhysAddr

Converts to this type from the input type.

impl From<u64> for PhysAddr

fn from(addr: u64) -> PhysAddr

Converts to this type from the input type.

impl From<usize> for PhysAddr

fn from(addr: usize) -> PhysAddr

Converts to this type from the input type.

impl Hash for PhysAddr

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

where __H: Hasher,

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 LowerHex for PhysAddr

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

Formats the value using the given formatter.

impl MemoryAddress for PhysAddr

type RAW = u64

Inner address type

fn raw(self) -> <PhysAddr as MemoryAddress>::RAW

Get the raw underlying address value.

impl Octal for PhysAddr

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

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.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PhysAddr

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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<(), Error>

Formats the value using the given formatter.

impl Shl<usize> for PhysAddr

type Output = PhysAddr

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> <PhysAddr as Shl<usize>>::Output

Performs the << operation.

impl ShlAssign<usize> for PhysAddr

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for PhysAddr

type Output = PhysAddr

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> <PhysAddr as Shr<usize>>::Output

Performs the >> operation.

impl ShrAssign<usize> for PhysAddr

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub<u64> for PhysAddr

type Output = PhysAddr

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> <PhysAddr as Sub<u64>>::Output

Performs the - operation.

impl Sub<usize> for PhysAddr

type Output = PhysAddr

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> <PhysAddr as Sub<usize>>::Output

Performs the - operation.

impl Sub for PhysAddr

type Output = u64

The resulting type after applying the - operator.

fn sub(self, rhs: PhysAddr) -> <PhysAddr as Sub>::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<(), Error>

Formats the value using the given formatter.

impl Copy for PhysAddr

impl Eq for PhysAddr

impl StructuralPartialEq for PhysAddr