Struct TraceInfo 

pub struct TraceInfo { /* private fields */ }

Information about a specific execution trace.

Trace info consists of the number of columns for all trace segments, trace length, the number of random elements needed to generate the auxiliary segment and optional custom metadata.

Currently, a trace can consist of at most two segments: the main segment and one auxiliary segment. Metadata is just a vector of bytes and can store any values up to 64KB in size.

Implementations

impl TraceInfo

pub const MIN_TRACE_LENGTH: usize = 8usize

Smallest allowed execution trace length; currently set at 8.

pub const MAX_TRACE_WIDTH: usize = 255usize

Maximum number of columns in an execution trace (across all segments); currently set at 255.

pub const MAX_META_LENGTH: usize = 65_535usize

Maximum number of bytes in trace metadata; currently set at 65535.

pub const MAX_RAND_SEGMENT_ELEMENTS: usize = 255usize

Maximum number of random elements in the auxiliary trace segment; currently set to 255.

pub fn new(width: usize, length: usize) -> TraceInfo

Creates a new TraceInfo from the specified trace width and length.

An execution trace described by this trace info is limited to a single segment.

Panics

Panics if:

• Trace width is zero or greater than 255.
• Trace length is smaller than 8 or is not a power of two.

pub fn with_meta(width: usize, length: usize, meta: Vec<u8>) -> TraceInfo

Creates a new TraceInfo from the specified trace width, length, and metadata.

An execution trace described by this trace info is limited to a single segment.

Panics

Panics if:

• Trace width is zero or greater than 255.
• Trace length is smaller than 8 or is not a power of two.
• Length of meta is greater than 65535;

pub fn new_multi_segment( main_segment_width: usize, aux_segment_width: usize, num_aux_segment_rands: usize, trace_length: usize, trace_meta: Vec<u8>, ) -> TraceInfo

Creates a new TraceInfo with main and auxiliary segments.

Panics

Panics if:

• The width of the first trace segment is zero.
• Total width of all trace segments is greater than 255.
• Trace length is smaller than 8 or is not a power of two.
• A zero entry in auxiliary segment width array is followed by a non-zero entry.
• Number of random elements for the auxiliary trace segment of non-zero width is set to zero.
• Number of random elements for the auxiliary trace segment of zero width is set to non-zero.
• Number of random elements for any auxiliary trace segment is greater than 255.

pub fn width(&self) -> usize

Returns the total number of columns in an execution trace.

This is guaranteed to be between 1 and 255.

pub fn length(&self) -> usize

Returns execution trace length.

The length is guaranteed to be a power of two.

pub fn meta(&self) -> &[u8]

Returns execution trace metadata.

pub fn is_multi_segment(&self) -> bool

Returns true if an execution trace contains the auxiliary trace segment.

pub fn main_trace_width(&self) -> usize

Returns the number of columns in the main segment of an execution trace.

This is guaranteed to be between 1 and 255.

pub fn aux_segment_width(&self) -> usize

Returns the number of columns in the auxiliary segment of an execution trace.

pub fn num_segments(&self) -> usize

Returns the total number of segments in an execution trace.

pub fn num_aux_segments(&self) -> usize

Returns the number of auxiliary trace segments in an execution trace.

pub fn get_aux_segment_width(&self) -> usize

Returns the number of columns in the auxiliary trace segment.

pub fn get_num_aux_segment_rand_elements(&self) -> usize

Returns the number of random elements needed to build all auxiliary columns.

Trait Implementations

impl Clone for TraceInfo

fn clone(&self) -> TraceInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TraceInfo

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

Formats the value using the given formatter.

impl Deserializable for TraceInfo

fn read_from<R>(source: &mut R) -> Result<TraceInfo, DeserializationError>

where R: ByteReader,

Reads TraceInfo from the specified source and returns the result.

Errors

Returns an error of a valid TraceInfo struct could not be read from the specified source.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for TraceInfo

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

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self and writes the resulting bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl<E> ToElements<E> for TraceInfo

where E: StarkField,

fn to_elements(&self) -> Vec<E>

impl Eq for TraceInfo

impl StructuralPartialEq for TraceInfo