Struct CallNode 

pub struct CallNode { /* private fields */ }

A Call node describes a function call such that the callee is executed in a different execution context from the currently executing code.

A call node can be of two types:

• A simple call: the callee is executed in the new user context.
• A syscall: the callee is executed in the root context.

Implementations

impl CallNode

Constants

pub const CALL_DOMAIN: Felt

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

pub const SYSCALL_DOMAIN: Felt

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

impl CallNode

Constructors

pub fn new( callee: MastNodeId, mast_forest: &MastForest, ) -> Result<Self, MastForestError>

Returns a new CallNode instantiated with the specified callee.

pub fn new_unsafe(callee: MastNodeId, digest: Word) -> Self

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

pub fn new_syscall( callee: MastNodeId, mast_forest: &MastForest, ) -> Result<Self, MastForestError>

Returns a new CallNode instantiated with the specified callee and marked as a kernel call.

pub fn new_syscall_unsafe(callee: MastNodeId, digest: Word) -> Self

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

impl CallNode

Public accessors

pub fn callee(&self) -> MastNodeId

Returns the ID of the node to be invoked by this call node.

pub fn is_syscall(&self) -> bool

Returns true if this call node represents a syscall.

pub fn domain(&self) -> Felt

Returns the domain of this call node.

Trait Implementations

impl Clone for CallNode

fn clone(&self) -> CallNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CallNode

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

Formats the value using the given formatter.

impl From<CallNode> for MastNode

fn from(v: CallNode) -> MastNode

Converts to this type from the input type.

impl MastNodeErrorContext for CallNode

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 CallNode

fn digest(&self) -> Word

Returns a commitment to this Call node.

The commitment is computed as a hash of the callee and an empty word ([ZERO; 4]) in the domain defined by either Self::CALL_DOMAIN or Self::SYSCALL_DOMAIN, depending on whether the node represents a simple call or a syscall - i.e.,:

Hasher::merge_in_domain(&[callee_digest, Word::default()], CallNode::CALL_DOMAIN);

or

Hasher::merge_in_domain(&[callee_digest, Word::default()], CallNode::SYSCALL_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 CallNode

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

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for CallNode

impl StructuralPartialEq for CallNode