pub struct Span { /* private fields */ }
Expand description

Block for a linear sequence of operations (i.e., no branching or loops).

Executes its operations in order. Fails if any of the operations fails.

A span is composed of operation batches, operation batches are composed of operation groups, operation groups encode the VM’s operations and immediate values. These values are created according to these rules:

  • A span contains one or more batches.
  • A batch contains exactly 8 groups.
  • A group contains exactly 9 operations or 1 immediate value.
  • NOOPs are used to fill a group or batch when necessary.
  • An immediate value follows the operation that requires it, using the next available group in the batch. If there are no batches available in the group, then both the operation and its immediate are moved to the next batch.

Example: 8 pushes result in two operation batches:

  • First batch: First group with 7 push opcodes and 2 zero-paddings packed together, followed by 7 groups with their respective immediate values.
  • Second batch: First group with the last push opcode and 8 zero-paddings packed together, followed by one immediate and 6 padding groups.

The hash of a span block is:

hash(batches, domain=SPAN_DOMAIN)

Where batches is the concatenation of each batch in the span, and each batch is 8 field elements (512 bits).

Implementations§

source§

impl Span

source

pub const DOMAIN: Felt = ZERO

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

source

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.
source

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.
source

pub fn hash(&self) -> Digest

Returns a hash of this code block.

source

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

Returns list of operation batches contained in this span block.

source

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.

source

pub fn decorators(&self) -> &DecoratorList

Returns a list of decorators in this span block

source

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§

source§

impl Clone for Span

source§

fn clone(&self) -> Span

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Span

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Span

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl RefUnwindSafe for Span

§

impl Send for Span

§

impl Sync for Span

§

impl Unpin for Span

§

impl UnwindSafe for Span

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.