Struct GuestPtr 

pub struct GuestPtr<T: GuestType> { /* private fields */ }

Implementations

impl<T: GuestType> GuestPtr<T>

pub fn read(&self) -> Result<&T, GuestReadFail>

Reads the value from the guest to be accessed later. This is a no-op if a value has already been cached. This is only needed if you need to read at a different time than you intend to.

If you want read a value and replace the cache if it exists, use GuestPtr::update instead. If you wish to read at time of first access, the GuestPtr only needs to be dereferenced without calling read ahead of time.

pub fn update(&mut self)

Reads the value from the guest, replacing it if any exists.

pub fn clear_cache(&mut self)

Clear the cached value, if any exists.

pub fn get_cached(&self) -> Option<&T>

Returns a reference to the cached value if one exists.

pub fn offset(&self, off: usize) -> Self

Creates a copy of the pointer offset by N items.

Note: Similar to normal pointer arithmatic the actual value of the offset will be multiplied by the size of the object.

pub fn offset_bytes(&self, bytes: usize) -> Self

Creates a copy of the pointer offset by N bytes.

pub fn cast<U: GuestType>(&self) -> GuestPtr<U>

Casts the GuestPtr to another type of GuestPtr

pub fn write(&mut self, func: impl FnOnce(&mut T)) -> Result<(), GuestWriteFail>

Write to the GuestPtr, with all modifications flushed at the end of the scope of the function provided to write.

Trait Implementations

impl<T: GuestType> Clone for GuestPtr<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: GuestType> From<u64> for GuestPtr<T>

fn from(pointer: target_ptr_t) -> Self

Converts to this type from the input type.

impl<T: GuestType> GuestType for GuestPtr<T>

fn guest_layout() -> Option<Layout>

fn read_from_guest( cpu: &mut CPUState, ptr: target_ptr_t, ) -> Result<Self, GuestReadFail>

fn write_to_guest( &self, cpu: &mut CPUState, ptr: target_ptr_t, ) -> Result<(), GuestWriteFail>

fn read_from_guest_phys(ptr: target_ptr_t) -> Result<Self, GuestReadFail>

fn write_to_guest_phys(&self, ptr: target_ptr_t) -> Result<(), GuestWriteFail>

fn guest_size() -> Option<usize>

The size of the type in the guest, None if the type is dynamically sized

fn guest_align() -> usize

The required minimum alignment of the type in the guest

impl<T: GuestType> Deref for GuestPtr<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.