Struct miden_vm::Assembler

pub struct Assembler { /* private fields */ }

The Assembler is the primary interface for compiling Miden Assembly to the Miden Abstract Syntax Tree (MAST).

Usage

Depending on your needs, there are multiple ways of using the assembler, and whether or not you want to provide a custom kernel.

Programs compiled with an empty kernel cannot use the `syscall` instruction.

• If you have a single executable module you want to compile, just call Assembler::assemble_program.
• If you want to link your executable to a few other modules that implement supporting procedures, build the assembler with them first, using the various builder methods on Assembler, e.g. Assembler::with_module, Assembler::with_library, etc. Then, call Assembler::assemble_program to get your compiled program.

Implementations

impl Assembler

This impl block contains no items.

Procedure Invocation

impl Assembler

This impl block contains no items.

Instruction Compilation

impl Assembler

Constructors

pub fn new(source_manager: Arc<dyn SourceManager>) -> Assembler

Start building an Assembler

pub fn with_kernel( source_manager: Arc<dyn SourceManager>, kernel_lib: KernelLibrary, ) -> Assembler

Start building an Assembler with a kernel defined by the provided KernelLibrary.

pub fn with_warnings_as_errors(self, yes: bool) -> Assembler

Sets the default behavior of this assembler with regard to warning diagnostics.

When true, any warning diagnostics that are emitted will be promoted to errors.

pub fn with_debug_mode(self, yes: bool) -> Assembler

Puts the assembler into the debug mode.

pub fn set_debug_mode(&mut self, yes: bool)

Sets the debug mode flag of the assembler

pub fn with_module(self, module: impl Compile) -> Result<Assembler, Report>

Adds module to the module graph of the assembler.

The given module must be a library module, or an error will be returned.

pub fn with_module_and_options( self, module: impl Compile, options: Options, ) -> Result<Assembler, Report>

Adds module to the module graph of the assembler with the given options.

The given module must be a library module, or an error will be returned.

pub fn add_module(&mut self, module: impl Compile) -> Result<(), Report>

Adds module to the module graph of the assembler.

The given module must be a library module, or an error will be returned.

pub fn add_module_with_options( &mut self, module: impl Compile, options: Options, ) -> Result<(), Report>

Adds module to the module graph of the assembler, using the provided options.

The given module must be a library or kernel module, or an error will be returned

pub fn add_library( &mut self, library: impl AsRef<Library>, ) -> Result<(), Report>

Adds the compiled library to provide modules for the compilation.

pub fn with_library( self, library: impl AsRef<Library>, ) -> Result<Assembler, Report>

Adds the compiled library to provide modules for the compilation.

impl Assembler

Public Accessors

pub fn warnings_as_errors(&self) -> bool

Returns true if this assembler promotes warning diagnostics as errors by default.

pub fn in_debug_mode(&self) -> bool

Returns true if this assembler was instantiated in debug mode.

pub fn kernel(&self) -> &Kernel

Returns a reference to the kernel for this assembler.

If the assembler was instantiated without a kernel, the internal kernel will be empty.

impl Assembler

Compilation/Assembly

pub fn assemble_library( self, modules: impl IntoIterator<Item = impl Compile>, ) -> Result<Library, Report>

Assembles a set of modules into a Library.

Errors

Returns an error if parsing or compilation of the specified modules fails.

pub fn assemble_kernel( self, module: impl Compile, ) -> Result<KernelLibrary, Report>

Assembles the provided module into a KernelLibrary intended to be used as a Kernel.

Errors

Returns an error if parsing or compilation of the specified modules fails.

pub fn assemble_program(self, source: impl Compile) -> Result<Program, Report>

Compiles the provided module into a Program. The resulting program can be executed on Miden VM.

Errors

Returns an error if parsing or compilation of the specified program fails, or if the source doesn’t have an entrypoint.

Trait Implementations

impl Clone for Assembler

fn clone(&self) -> Assembler

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Assembler

fn default() -> Assembler

Returns the “default value” for a type.