Struct kdmp_parser::Gpa

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

Strong type for Guest Physical Addresses.

Examples

let gpa = Gpa::new(0x1337_123);
assert_eq!(gpa.offset(), 0x123);
assert_eq!(gpa.page_aligned(), false);
let aligned_gpa = gpa.page_align();
assert_eq!(aligned_gpa.u64(), 0x1337_000);
assert_eq!(aligned_gpa.page_aligned(), true);
let next_gpa = gpa.next_aligned_page();
assert_eq!(next_gpa.u64(), 0x1338_000);

Implementations

impl Gpa

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

Create a new Gpa.

Examples

let gpa = Gpa::new(1337);

pub const fn from_pfn(pfn: Pfn) -> Self

Create a new Gpa from a Page Frame Number or PFN.

Examples

let gpa = Gpa::from_pfn(Pfn::new(0x1337));
assert_eq!(gpa.u64(), 0x1337_000);

pub const fn from_pfn_with_offset(pfn: Pfn, offset: u64) -> Self

Create a new Gpa from a Page Frame Number or PFN and an added offset.

Examples

let gpa = Gpa::from_pfn_with_offset(Pfn::new(0x1337), 0x11);
assert_eq!(gpa.u64(), 0x1337_011);

pub const fn pfn(&self) -> u64

Get the Page Frame Number from a Gpa.

Examples

let gpa = Gpa::new(0x1337_337);
assert_eq!(gpa.pfn(), 0x1337);

Trait Implementations

impl AddAssign for Gpa

Operator += for Gpa.

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Gpa

fn clone(&self) -> Gpa

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Gpa

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

Formats the value using the given formatter.

impl Default for Gpa

fn default() -> Gpa

Returns the “default value” for a type.

impl Display for Gpa

Format a Gpa as a string.

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

Formats the value using the given formatter.

impl From<&Gpa> for u64

Convert a &Gpa into a u64.

fn from(value: &Gpa) -> Self

Create a u64 from a &Gpa.

Examples

let gpa = Gpa::new(0xdeadbeef_baadc0de);
let gpa_p = &gpa;
let gpa_u64: u64 = gpa_p.into();
assert_eq!(gpa_u64, 0xdeadbeef_baadc0de);
assert_eq!(u64::from(gpa_p), 0xdeadbeef_baadc0de);

impl From<Gpa> for u64

Convert a Gpa into a u64.

fn from(value: Gpa) -> Self

Create a u64 from a Gpa.

Examples

let gpa = Gpa::new(0xdeadbeef_baadc0de);
let gpa_u64: u64 = gpa.into();
assert_eq!(gpa_u64, 0xdeadbeef_baadc0de);
assert_eq!(u64::from(gpa), 0xdeadbeef_baadc0de);

impl From<u64> for Gpa

Convert a u64 into a Gpa.

fn from(value: u64) -> Self

Create a Gpa from a u64.

Examples

let gpa = Gpa::from(0xdeadbeef_baadc0de);
assert_eq!(u64::from(gpa), 0xdeadbeef_baadc0de);

impl Gxa for Gpa

fn u64(&self) -> u64

Get the underlying u64.

Examples

let gpa = Gpa::new(1337);
assert_eq!(gpa.u64(), 1337);

fn offset(&self) -> u64

Get the page offset.

fn page_aligned(&self) -> bool

Is it page aligned?

fn page_align(&self) -> Self

Page-align it.

fn next_aligned_page(self) -> Self

Get the next aligned page.

impl Hash for Gpa

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 Ord for Gpa

fn cmp(&self, other: &Gpa) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Gpa

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

fn partial_cmp(&self, other: &Gpa) -> 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 Copy for Gpa

impl Eq for Gpa

impl StructuralPartialEq for Gpa