Struct MemoryImage 

pub struct MemoryImage { /* private fields */ }

A memory image

A full memory image of a zkVM guest. Includes functionality for accessing memory and associated digests, and for initializing the memory state for a Program.

Implementations

impl MemoryImage

pub fn new_user(program: Program) -> Self

Creates the initial memory state for a user-mode program.

pub fn new_kernel(program: Program) -> Self

Creates the initial memory state for a kernel-mode program.

pub fn with_kernel(user: Program, kernel: Program) -> Self

Creates the initial memory state for a user-mode user Program with a kernel-mode kernel Program.

pub fn get_page_indexes(&self) -> BTreeSet<u32>

Returns a set of the page indexes that are loaded.

pub fn digests(&self) -> impl Iterator<Item = (&u32, &Digest)> + '_

Sorted iterator over page digests (page_idx -> Digest)

pub fn get_page(&mut self, page_idx: u32) -> Result<Page>

Return the page data, fails if unavailable

pub fn set_page(&mut self, page_idx: u32, page: Page)

Set the data for a page

pub fn set_page_with_digest( &mut self, page_idx: u32, page: Page, digest: Digest, )

Set the data for a page and with the given digest

pub fn get_digest(&mut self, digest_idx: u32) -> Result<&Digest>

Get a digest, fails if unavailable

pub fn set_digest(&mut self, digest_idx: u32, digest: Digest)

Set a digest

pub fn image_id(&mut self) -> Digest

Return the root digest

pub fn user_id(&mut self) -> Digest

Return the user portion of the MT

pub fn kernel_id(&mut self) -> Digest

Return the kernel portion of the MT

pub fn update_digests(&mut self)

After making changes to the image, call this to update all the digests that need to be updated.

pub fn into_pages(self) -> BTreeMap<u32, Page>

Discard the hashes and turn the MemoryImage into just its pages

Trait Implementations

impl Clone for MemoryImage

fn clone(&self) -> MemoryImage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryImage

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

Formats the value using the given formatter.

impl Default for MemoryImage

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MemoryImage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MemoryImage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.