Struct Program

pub struct Program { /* private fields */ }

An executable program for Miden VM.

A program consists of a MAST forest, an entrypoint defining the MAST node at which the program execution begins, and a definition of the kernel against which the program must be executed (the kernel can be an empty kernel).

Implementations

impl Program

Constructors

pub fn new(mast_forest: Arc<MastForest>, entrypoint: MastNodeId) -> Program

Construct a new Program from the given MAST forest and entrypoint. The kernel is assumed to be empty.

Panics:

• if mast_forest doesn’t contain the specified entrypoint.
• if the specified entrypoint is not a procedure root in the mast_forest.

pub fn with_kernel( mast_forest: Arc<MastForest>, entrypoint: MastNodeId, kernel: Kernel, ) -> Program

Construct a new Program from the given MAST forest, entrypoint, and kernel.

Panics:

• if mast_forest doesn’t contain the specified entrypoint.
• if the specified entrypoint is not a procedure root in the mast_forest.

pub fn with_advice_map(self, advice_map: AdviceMap) -> Program

Produces a new program with the existing MastForest and where all key/values in the provided advice map are added to the internal advice map.

impl Program

Public accessors

pub fn hash(&self) -> RpoDigest

Returns the hash of the program’s entrypoint.

Equivalently, returns the hash of the root of the entrypoint procedure.

pub fn entrypoint(&self) -> MastNodeId

Returns the entrypoint associated with this program.

pub fn mast_forest(&self) -> &Arc<MastForest>

Returns a reference to the underlying MastForest.

pub fn kernel(&self) -> &Kernel

Returns the kernel associated with this program.

pub fn get_node_by_id(&self, node_id: MastNodeId) -> Option<&MastNode>

Returns the MastNode associated with the provided MastNodeId if valid, or else None.

This is the fallible version of indexing (e.g. program[node_id]).

pub fn find_procedure_root(&self, digest: RpoDigest) -> Option<MastNodeId>

Returns the MastNodeId of the procedure root associated with a given digest, if any.

pub fn num_procedures(&self) -> u32

Returns the number of procedures in this program.

impl Program

Serialization

pub fn write_to_file<P>(&self, path: P) -> Result<(), Error>

where P: AsRef<Path>,

Writes this Program to the provided file path.

Trait Implementations

impl Clone for Program

fn clone(&self) -> Program

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Program

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

Formats the value using the given formatter.

impl Deserializable for Program

fn read_from<R>(source: &mut R) -> Result<Program, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl Display for Program

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

Formats the value using the given formatter.

impl From<Program> for ProgramInfo

fn from(program: Program) -> ProgramInfo

Converts to this type from the input type.

impl PartialEq for Program

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

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

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

Pretty-print this object to the given core::fmt::Formatter.

impl Serializable for Program

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for Program

impl StructuralPartialEq for Program