Struct miden_processor::MastForest

pub struct MastForest { /* private fields */ }

Represents one or more procedures, represented as a collection of MastNodes.

A MastForest does not have an entrypoint, and hence is not executable. A crate::Program can be built from a MastForest to specify an entrypoint.

Implementations

impl MastForest

Constructors

pub fn new() -> MastForest

Creates a new empty MastForest.

impl MastForest

State mutators

pub fn add_node( &mut self, node: MastNode, ) -> Result<MastNodeId, MastForestError>

Adds a node to the forest, and returns the associated MastNodeId.

Adding two duplicate nodes will result in two distinct returned MastNodeIds.

pub fn add_block( &mut self, operations: Vec<Operation>, decorators: Option<Vec<(usize, Decorator)>>, ) -> Result<MastNodeId, MastForestError>

Adds a basic block node to the forest, and returns the MastNodeId associated with it.

pub fn add_join( &mut self, left_child: MastNodeId, right_child: MastNodeId, ) -> Result<MastNodeId, MastForestError>

Adds a join node to the forest, and returns the MastNodeId associated with it.

pub fn add_split( &mut self, if_branch: MastNodeId, else_branch: MastNodeId, ) -> Result<MastNodeId, MastForestError>

Adds a split node to the forest, and returns the MastNodeId associated with it.

pub fn add_loop( &mut self, body: MastNodeId, ) -> Result<MastNodeId, MastForestError>

Adds a loop node to the forest, and returns the MastNodeId associated with it.

pub fn add_call( &mut self, callee: MastNodeId, ) -> Result<MastNodeId, MastForestError>

Adds a call node to the forest, and returns the MastNodeId associated with it.

pub fn add_syscall( &mut self, callee: MastNodeId, ) -> Result<MastNodeId, MastForestError>

Adds a syscall node to the forest, and returns the MastNodeId associated with it.

pub fn add_dyn(&mut self) -> Result<MastNodeId, MastForestError>

Adds a dyn node to the forest, and returns the MastNodeId associated with it.

pub fn add_external( &mut self, mast_root: RpoDigest, ) -> Result<MastNodeId, MastForestError>

Adds an external node to the forest, and returns the MastNodeId associated with it.

pub fn make_root(&mut self, new_root_id: MastNodeId)

Marks the given MastNodeId as being the root of a procedure.

Panics

• if new_root_id’s internal index is larger than the number of nodes in this forest (i.e. clearly doesn’t belong to this MAST forest).

impl MastForest

Public accessors

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 failable version of indexing (e.g. mast_forest[node_id]).

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

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

pub fn is_procedure_root(&self, node_id: MastNodeId) -> bool

Returns true if a node with the specified ID is a root of a procedure in this MAST forest.

pub fn procedure_digests(&self) -> impl Iterator<Item = RpoDigest>

Returns an iterator over the digest of the procedures in this MAST forest.

pub fn procedure_roots(&self) -> &[MastNodeId]

Returns an iterator over the IDs of the procedures in this MAST forest.

pub fn num_procedures(&self) -> u32

Returns the number of procedures in this MAST forest.

Trait Implementations

impl Clone for MastForest

fn clone(&self) -> MastForest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MastForest

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

Formats the value using the given formatter.

impl Default for MastForest

fn default() -> MastForest

Returns the “default value” for a type.

impl Deserializable for MastForest

fn read_from<R>(source: &mut R) -> Result<MastForest, 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 From<Program> for MastForest

fn from(program: Program) -> MastForest

Converts to this type from the input type.

impl Index<MastNodeId> for MastForest

type Output = MastNode

The returned type after indexing.

fn index( &self, node_id: MastNodeId, ) -> &<MastForest as Index<MastNodeId>>::Output

Performs the indexing (container[index]) operation.

impl PartialEq for MastForest

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

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 MastForest

impl StructuralPartialEq for MastForest