Struct miden_objects::assembly::ModuleAst

pub struct ModuleAst { /* private fields */ }

An abstract syntax tree of a Miden module.

A module AST consists of a list of procedure ASTs, a list of re-exported procedures, a list of imports, and module documentation. Local procedures could be internal or exported.

Implementations

impl ModuleAst

pub fn new( local_procs: Vec<ProcedureAst>, reexported_procs: Vec<ProcReExport>, docs: Option<String>, ) -> Result<ModuleAst, ParsingError>

Returns a new ModuleAst.

A module consists of internal and exported procedures but does not contain a body.

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

Adds the provided import information to the module.

Panics

Panics if import information has already been added.

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

Parses the provided source into a ModuleAst.

A module consists of internal and exported procedures but does not contain a body.

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

Returns a list of procedures in this module.

pub fn reexported_procs(&self) -> &[ProcReExport]

Returns a list of re-exported procedures in this module.

pub fn docs(&self) -> Option<&String>

Returns doc comments for this module.

pub fn import_info(&self) -> &ModuleImports

Returns a reference to the import information for this module

pub fn clear_locations(&mut self)

Clears the source locations from this module.

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

where R: ByteWriter,

Returns byte representation of this ModuleAst.

The serde options are NOT serialized - the caller must keep track of the serialization options used.

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

where R: ByteReader,

Returns a ModuleAst struct deserialized from the provided source.

The serde options must correspond to the options used for serialization.

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

Returns byte representation of this ModuleAst.

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

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

Returns a ModuleAst 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] of the procedures via ProcedureAst::load_source_locations.

The local procedures are expected to have deterministic order from parse. This way, the serialization can be simplified into a contiguous sequence of locations.

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

where W: ByteWriter,

Writes the [SourceLocation] of the procedures via ProcedureAst::write_source_locations.

The local procedures are expected to have deterministic order from parse. This way, the serialization can be simplified into a contiguous sequence of locations.

pub fn clear_imports(&mut self)

Clear import info from the module

Trait Implementations

impl Clone for ModuleAst

fn clone(&self) -> ModuleAst

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleAst

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

Formats the value using the given formatter.

impl Display for ModuleAst

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

Writes this ModuleAst 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 module.

impl PartialEq for ModuleAst

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

impl StructuralPartialEq for ModuleAst