Struct GuestAddress

pub struct GuestAddress(pub u64);

Represents an Address in the guest’s memory.

Tuple Fields

0: u64

Implementations

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.

pub fn align(self, align: u64) -> Option<GuestAddress>

Returns the next highest address that is a multiple of align, or an unchanged copy of the address if it’s already a multiple of align. Returns None on overflow.

align must be a power of 2.

pub fn align_down(self, align: u64) -> GuestAddress

Returns the next lowest address that is a multiple of align, or an unchanged copy of the address if it’s already a multiple of align.

align must be a power of 2.

Trait Implementations

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 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 Debug for GuestAddress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GuestAddress

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GuestAddress

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

Formats the value using the given formatter.

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

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 GuestAddress

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for GuestAddress

impl Eq for GuestAddress