Struct sys_util::GuestAddress

pub struct GuestAddress(pub u64);

Represents an Address in the guest's memory.

Methods

impl GuestAddress

pub fn offset_from(&self, base: GuestAddress) -> u64

Returns the offset from this address to the given base address.

Examples

  let base = GuestAddress(0x100);
  let addr = GuestAddress(0x150);
  assert_eq!(addr.offset_from(base), 0x50u64);

pub fn offset(&self) -> u64

Returns the address as a u64 offset from 0x0. Use this when a raw number is needed to pass to the kernel.

pub fn checked_add(&self, other: u64) -> Option<GuestAddress>

Returns the result of the add or None if there is overflow.

pub fn unchecked_add(&self, offset: u64) -> GuestAddress

Returns the result of the base address + the size. Only use this when offset is guaranteed not to overflow.

pub fn checked_sub(&self, other: u64) -> Option<GuestAddress>

Returns the result of the subtraction of None if there is underflow.

pub fn mask(&self, mask: u64) -> GuestAddress

Returns the bitwise and of the address with the given mask.

Trait Implementations

impl Eq for GuestAddress

impl Clone for GuestAddress

fn clone(&self) -> GuestAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for GuestAddress

impl PartialOrd<GuestAddress> for GuestAddress

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

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

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

#[must_use]

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

This method tests for !=.

impl Ord for GuestAddress

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl BitAnd<u64> for GuestAddress

type Output = GuestAddress

The resulting type after applying the & operator.

fn bitand(self, other: u64) -> GuestAddress

Performs the & operation.

impl BitOr<u64> for GuestAddress

type Output = GuestAddress

The resulting type after applying the | operator.

fn bitor(self, other: u64) -> GuestAddress

Performs the | operation.

impl Debug for GuestAddress

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

Formats the value using the given formatter.