Struct miden_objects::assembly::ProgramAst

pub struct ProgramAst { /* private fields */ }

An abstract syntax tree of an executable Miden program.

A program AST consists of a body of the program, a list of internal procedure ASTs, a list of imported libraries, a map from procedure ids to procedure names for imported procedures used in the module, and the source location of the program.

Implementations

impl ProgramAst

pub fn new( body: Vec<Node>, local_procs: Vec<ProcedureAst> ) -> Result<ProgramAst, ParsingError>

Returns a new ProgramAst.

A program consist of a body and a set of internal (i.e., not exported) procedures.

Errors

Returns an error if:

• The number of body nodes is greater than or equal to 2^16.
• The number of local procedures is greater than or equal to 2^16.

pub fn with_import_info(self, import_info: ModuleImports) -> ProgramAst

Adds the provided import information to the program.

Panics

Panics if import information has already been added.

pub fn with_source_locations<L>( self, locations: L, start: SourceLocation ) -> ProgramAst

where L: IntoIterator<Item = SourceLocation>,

Binds the provided locations to the nodes of this program’s body.

The start location points to the begin token which does not have its own node.

Panics

Panics if source location information has already been associated with this program.

pub fn source_locations(&self) -> impl Iterator<Item = &SourceLocation>

Returns the SourceLocation associated with this program, if present.

pub fn procedures(&self) -> &[ProcedureAst]

Returns a slice over the internal procedures of this program.

pub fn body(&self) -> &CodeBody

Returns a reference to the body of this program.

pub fn import_info(&self) -> &ModuleImports

Returns a reference to the import info for this program

pub fn parse(source: &str) -> Result<ProgramAst, ParsingError>

Parses the provided source into a ProgramAst.

A program consist of a body and a set of internal (i.e., not exported) procedures.

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

where W: ByteWriter,

Writes byte representation of this ProgramAst into the specified target according with the specified serde options.

The serde options are serialized as header information for the purposes of deserialization.

pub fn to_bytes(&self, options: AstSerdeOptions) -> Vec<u8>

Returns byte representation of this ProgramAst.

The serde options are serialized as header information for the purposes of deserialization.

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

where R: ByteReader,

Returns a ProgramAst struct deserialized from the specified reader.

This function assumes that the byte array contains a serialized AstSerdeOptions struct as a header.

pub fn from_bytes(bytes: &[u8]) -> Result<ProgramAst, DeserializationError>

Returns a ProgramAst struct deserialized from the provided bytes.

This function assumes that the byte array contains a serialized AstSerdeOptions struct as a header.

pub fn load_source_locations<R>( &mut self, source: &mut R ) -> Result<(), DeserializationError>

where R: ByteReader,

Loads the SourceLocation from the source.

It expects the start location at the first position, and will subsequently load the body via CodeBody::load_source_locations. Finally, it will load the local procedures via ProcedureAst::load_source_locations.

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

where W: ByteWriter,

Writes the SourceLocation into target.

It will write the start location, and then execute the body serialization via [CodeBlock::write_source_locations]. Finally, it will write the local procedures via ProcedureAst::write_source_locations.

pub fn into_parts(self) -> (Vec<ProcedureAst>, Vec<Node>)

Returns local procedures and body nodes of this program.

pub fn clear_imports(&mut self)

Clear import info from the program

pub fn write_to_file<P>(&self, file_path: P) -> Result<(), Error>

where P: AsRef<Path>,

Writes ProgramAst to provided file path

Trait Implementations

impl Clone for ProgramAst

fn clone(&self) -> ProgramAst

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProgramAst

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

Formats the value using the given formatter.

impl Display for ProgramAst

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

Writes this ProgramAst as formatted MASM code into the formatter.

The formatted code puts each instruction on a separate line and preserves correct indentation for instruction blocks.

Panics

Panics if import info is not associated with this program.

impl PartialEq for ProgramAst

fn eq(&self, other: &ProgramAst) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ProgramAst

impl StructuralPartialEq for ProgramAst