Struct miden_core::code_blocks::Span

pub struct Span { /* private fields */ }

A code block used to describe a linear sequence of operations (i.e., no branching or loops).

When the VM executes a Span block, it breaks the sequence of operations into batches and groups according to the following rules:

• A group may contain up to 9 operations or a single immediate value.
• An operation carrying an immediate value cannot be in the 9th position in a group.
• A batch may contain up to 8 groups.
• There is no limit on the number of batches contained within a single span.

Thus, for example, executing 8 pushes in a row will result in two operation batches:

• The first batch will contain 8 groups, with the first group containing 7 push opcodes, and the remaining 7 groups containing immediate values for each of the push operations.
• The second batch will contain 2 groups, with the first group containing a single push opcode, and the second group containing the immediate value for the last push operation.

If a sequence of operations does not have any operations which carry immediate values, then up to 72 operations can fit into a single batch.

TODO: describe how Span hash is computed.

Implementations

impl Span

pub fn new(operations: Vec<Operation>) -> Self

Returns a new Span block instantiated with the specified operations.

Errors (TODO)

Returns an error if:

• operations vector is empty.
• operations vector contains any number of system operations.

pub fn with_decorators(
    operations: Vec<Operation>,
    decorators: DecoratorList
) -> Self

Returns a new Span block instantiated with the specified operations and decorators.

Errors (TODO)

Returns an error if:

• operations vector is empty.
• operations vector contains any number of system operations.

pub fn hash(&self) -> Digest

Returns a hash of this code block.

pub fn op_batches(&self) -> &[OpBatch]

Returns list of operation batches contained in this span block.

pub fn replicate(&self, num_copies: usize) -> Self

Returns a new Span block instantiated with operations from this block repeated the specified number of times.

pub fn decorators(&self) -> &DecoratorList

Returns a list of decorators in this span block

pub fn decorator_iter(&self) -> DecoratorIterator<'_>

Returns a DecoratorIterator which allows us to iterate through the decorator list of this span block while executing operation batches of this span block

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Span

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

Formats the value using the given formatter.

impl Display for Span

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

Formats the value using the given formatter.