Struct Program

Source
pub struct Program { /* private fields */ }
Expand description

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§

Source§

impl Program

Constructors

Source

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

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.
Source

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

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.
Source

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

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.

Source§

impl Program

Public accessors

Source

pub fn hash(&self) -> Word

Returns the hash of the program’s entrypoint.

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

Source

pub fn entrypoint(&self) -> MastNodeId

Returns the entrypoint associated with this program.

Source

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

Returns a reference to the underlying MastForest.

Source

pub fn kernel(&self) -> &Kernel

Returns the kernel associated with this program.

Source

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]).

Source

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

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

Source

pub fn num_procedures(&self) -> u32

Returns the number of procedures in this program.

Source§

impl Program

Serialization

Source

pub fn write_to_file<P>(&self, path: P) -> Result<()>
where P: AsRef<Path>,

Writes this Program to the provided file path.

Trait Implementations§

Source§

impl Clone for Program

Source§

fn clone(&self) -> Program

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Program

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deserializable for Program

Source§

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

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

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

Attempts to deserialize the provided bytes into Self and returns the result. Read more
Source§

impl Display for Program

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Program> for ProgramInfo

Source§

fn from(program: Program) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Program

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PrettyPrint for Program

Source§

fn render(&self) -> Document

The core of the PrettyPrint functionality. Read more
Source§

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object. Read more
Source§

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

Pretty-print this object to the given core::fmt::Formatter. Read more
Source§

impl Serializable for Program

Source§

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

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

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

Serializes self into a vector of bytes.
Source§

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self. Read more
Source§

impl Eq for Program

Source§

impl StructuralPartialEq for Program

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V