Struct Program

pub struct Program {
    pub instructions: Vec<Instruction>,
    /* private fields */
}

A program for Triton VM. Triton VM can run and profile such programs, and trace its execution in order to generate a proof of correct execution. See there for details.

A program may contain debug information, such as label names and breakpoints. Access this information through methods label_for_address() and is_breakpoint(). Some operations, most notably BField-encoding, discard this debug information.

Fields

instructions: Vec<Instruction>

Implementations

impl Program

pub fn new(labelled_instructions: &[LabelledInstruction]) -> Self

pub fn from_code(code: &str) -> Result<Self, ParseError<'_>>

Create a Program by parsing source code.

pub fn labelled_instructions(&self) -> Vec<LabelledInstruction>

pub fn is_breakpoint(&self, address: u64) -> bool

pub fn type_hints_at(&self, address: u64) -> Vec<TypeHint>

pub fn assertion_context_at(&self, address: u64) -> Option<AssertionContext>

pub fn to_bwords(&self) -> Vec<BFieldElement>

Turn the program into a sequence of BFieldElements. Each instruction is encoded as its opcode, followed by its argument (if any).

Note: This is almost (but not quite!) equivalent to encoding the program. For that, use encode() instead.

pub fn len_bwords(&self) -> usize

The total length of the program as BFieldElements. Double-word instructions contribute two BFieldElements.

pub fn is_empty(&self) -> bool

pub fn hash(&self) -> Digest

Produces the program’s canonical hash digest. Uses Tip5, the canonical hash function for Triton VM.

pub fn label_for_address(&self, address: u64) -> String

The label for the given address, or a deterministic, unique substitute if no label is found.

Trait Implementations

impl<'a> Arbitrary<'a> for Program

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl BFieldCodec for Program

type Error = ProgramDecodingError

fn decode(sequence: &[BFieldElement]) -> Result<Box<Self>, Self::Error>

fn encode(&self) -> Vec<BFieldElement>

fn static_length() -> Option<usize>

Returns the length in number of BFieldElements if it is known at compile-time. Otherwise, None.

impl Clone for Program

fn clone(&self) -> Program

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Program

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Program

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Program

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

Formats the value using the given formatter.

impl GetSize for Program

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

impl IntoIterator for Program

type Item = AnInstruction<BFieldElement>

The type of the elements being iterated over.

type IntoIter = InstructionIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Program

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Program