Struct miden_objects::assembly::mast::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: BaseElement = _

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

pub const SYSCALL_DOMAIN: BaseElement = _

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

impl CallNode

Constructors

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

Returns a new CallNode instantiated with the specified callee.

pub fn new_unsafe(callee: MastNodeId, digest: RpoDigest) -> CallNode

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<CallNode, MastForestError>

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

pub fn new_syscall_unsafe(callee: MastNodeId, digest: RpoDigest) -> CallNode

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 digest(&self) -> RpoDigest

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, Digest::default()], CallNode::CALL_DOMAIN);

or

Hasher::merge_in_domain(&[callee_digest, Digest::default()], CallNode::SYSCALL_DOMAIN);

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) -> BaseElement

Returns the domain of this call node.

Trait Implementations

impl Clone for CallNode

fn clone(&self) -> CallNode

Returns a copy 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<(), Error>

Formats the value using the given formatter.

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 Eq for CallNode

impl StructuralPartialEq for CallNode