Struct LoopNode 

pub struct LoopNode { /* private fields */ }

A Loop node defines condition-controlled iterative execution. When the VM encounters a Loop node, it will keep executing the body of the loop as long as the top of the stack is `1``.

The loop is exited when at the end of executing the loop body the top of the stack is 0``. If the top of the stack is neither 0nor1` when the condition is checked, the execution fails.

Implementations

impl LoopNode

Constants

pub const DOMAIN: Felt

The domain of the loop node (used for control block hashing).

impl LoopNode

pub fn body(&self) -> MastNodeId

Returns the ID of the node presenting the body of the loop.

Trait Implementations

impl Clone for LoopNode

fn clone(&self) -> LoopNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LoopNode

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

Formats the value using the given formatter.

impl From<LoopNode> for MastNode

fn from(value: LoopNode) -> Self

Converts to this type from the input type.

impl MastNodeErrorContext for LoopNode

fn decorators<'a>( &'a self, forest: &'a MastForest, ) -> impl Iterator<Item = DecoratedOpLink> + 'a

The list of decorators tied to this node, along with their associated index.

fn get_assembly_op<'m>( &self, mast_forest: &'m MastForest, target_op_idx: Option<usize>, ) -> Option<&'m AssemblyOp>

Returns the AssemblyOp associated with this node and operation (if provided), if any.

impl MastNodeExt for LoopNode

fn digest(&self) -> Word

Returns a commitment to this Loop node.

The commitment is computed as a hash of the loop body and an empty word ([ZERO; 4]) in the domain defined by Self::DOMAIN - i..e,:

Hasher::merge_in_domain(&[body_digest, Word::default()], LoopNode::DOMAIN);

fn before_enter<'a>(&'a self, forest: &'a MastForest) -> &'a [DecoratorId]

Returns the decorators to be executed before this node is executed.

fn after_exit<'a>(&'a self, forest: &'a MastForest) -> &'a [DecoratorId]

Returns the decorators to be executed after this node is executed.

type Builder = LoopNodeBuilder

Converts this node into its corresponding builder, reusing allocated data where possible.

fn to_display<'a>( &'a self, mast_forest: &'a MastForest, ) -> Box<dyn Display + 'a>

Returns a display formatter for this node.

fn to_pretty_print<'a>( &'a self, mast_forest: &'a MastForest, ) -> Box<dyn PrettyPrint + 'a>

Returns a pretty printer for this node.

fn has_children(&self) -> bool

Returns true if the this node has children.

fn append_children_to(&self, target: &mut Vec<MastNodeId>)

Appends the NodeIds of the children of this node, if any, to the vector.

fn for_each_child<F>(&self, f: F)

where F: FnMut(MastNodeId),

Executes the given closure for each child of this node.

fn domain(&self) -> Felt

Returns the domain of this node.

fn to_builder(self, forest: &MastForest) -> Self::Builder

fn verify_node_in_forest(&self, forest: &MastForest)

Verifies that this node is stored at the ID in its decorators field in the forest.

impl PartialEq for LoopNode

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

impl StructuralPartialEq for LoopNode