Struct JoinNode 

pub struct JoinNode { /* private fields */ }

A Join node describe sequential execution. When the VM encounters a Join node, it executes the first child first and the second child second.

Implementations

impl JoinNode

Constants

pub const DOMAIN: Felt

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

impl JoinNode

Constructors

pub fn new( children: [MastNodeId; 2], mast_forest: &MastForest, ) -> Result<Self, MastForestError>

Returns a new JoinNode instantiated with the specified children nodes.

pub fn new_unsafe(children: [MastNodeId; 2], digest: Word) -> Self

Returns a new JoinNode from values that are assumed to be correct. Should only be used when the source of the inputs is trusted (e.g. deserialization).

impl JoinNode

Public accessors

pub fn first(&self) -> MastNodeId

Returns the ID of the node that is to be executed first.

pub fn second(&self) -> MastNodeId

Returns the ID of the node that is to be executed after the execution of the program defined by the first node completes.

Trait Implementations

impl Clone for JoinNode

fn clone(&self) -> JoinNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JoinNode

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

Formats the value using the given formatter.

impl From<JoinNode> for MastNode

fn from(v: JoinNode) -> MastNode

Converts to this type from the input type.

impl MastNodeErrorContext for JoinNode

fn decorators(&self) -> impl Iterator<Item = (usize, DecoratorId)>

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 JoinNode

fn digest(&self) -> Word

Returns a commitment to this Join node.

The commitment is computed as a hash of the first and second child node in the domain defined by Self::DOMAIN - i.e.,:

Hasher::merge_in_domain(&[first_child_digest, second_child_digest], JoinNode::DOMAIN);

fn before_enter(&self) -> &[DecoratorId]

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

fn after_exit(&self) -> &[DecoratorId]

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

fn append_before_enter(&mut self, decorator_ids: &[DecoratorId])

Sets the list of decorators to be executed before this node.

fn append_after_exit(&mut self, decorator_ids: &[DecoratorId])

Sets the list of decorators to be executed after this node.

fn remove_decorators(&mut self)

Removes all decorators from this node.

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 remap_children(&self, remapping: &Remapping) -> Self

Remap the node children to their new positions indicated by the given Remapping.

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 domain(&self) -> Felt

Returns the domain of this node.

impl PartialEq for JoinNode

fn eq(&self, other: &JoinNode) -> 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 TryInto<JoinNode> for MastNode

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<JoinNode, <Self as TryInto<JoinNode>>::Error>

Performs the conversion.

impl Eq for JoinNode

impl StructuralPartialEq for JoinNode