Struct Compiler 

pub struct Compiler {
    pub unit_name: Option<String>,
    pub statements_before_dce: u32,
    pub statements_after_dce: u32,
    /* private fields */
}

The primary entry point of the Leo compiler.

Fields

unit_name: Option<String>

The name of the compilation unit (program or library).

statements_before_dce: u32

How many statements were in the AST before DCE?

statements_after_dce: u32

How many statements were in the AST after DCE?

Implementations

impl Compiler

pub fn network(&self) -> NetworkName

Return the network selected for this compiler instance.

pub fn parse_program( &mut self, source: &str, filename: FileName, modules: &[(&str, FileName)], ) -> Result<()>

Parses the given source into a program AST and stores it in the compiler state.

The source file and any provided module sources are first registered in the session source map so spans can be resolved correctly. The parser then constructs the program AST from the main source and its modules.

After parsing, this verifies that the program scope name matches the expected program name (from program.json or the test filename). The resulting AST is stored in self.state.ast, and optionally written to disk if configured.

pub fn parse_and_return_program( &mut self, source: &str, filename: FileName, modules: &[(&str, FileName)], ) -> Result<Program>

Simple wrapper around parse_program that also returns a program AST.

pub fn parse_and_return_library( &mut self, library_name: &str, source: &str, filename: FileName, modules: &[(&str, FileName)], ) -> Result<Library>

Simple wrapper around parse_library that also returns a library AST.

pub fn parse_library( &mut self, library_name: Symbol, source: &str, filename: FileName, modules: &[(&str, FileName)], ) -> Result<()>

Parses a library source (and its submodules) into a library AST.

All source strings are registered in the session source map so span information can be resolved correctly. The resulting AST is stored in self.state.ast.

pub fn analyze_frontend_from_directory_with_file_source( &mut self, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, file_source: &impl FileSource, ) -> Result<FrontendAnalysis<'_>>

Parses a package entry file, merges import stubs when applicable, and runs frontend passes.

Unlike the full compile pipeline, this stops after semantic frontend analysis and returns borrowed access to the AST, symbol table, and type table. The LSP uses this to build semantic indices without running code generation or writing artifacts to disk.

pub fn analyze_frontend_from_directory_with_file_source_and_check<C>( &mut self, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, file_source: &impl FileSource, should_continue: C, ) -> Result<FrontendAnalysis<'_>>

where C: FnMut() -> Result<()>,

Equivalent to Self::analyze_frontend_from_directory_with_file_source, but checks should_continue at parse and pass boundaries so editor tooling can abandon stale work before completing the entire frontend pipeline.

pub fn new( expected_unit_name: Option<String>, is_test: bool, handler: Handler, node_builder: Rc<NodeBuilder>, output_directory: PathBuf, compiler_options: Option<CompilerOptions>, import_stubs: IndexMap<Symbol, Stub>, network: NetworkName, ) -> Self

Returns a new Leo compiler.

pub fn do_pass<P: Pass>(&mut self, input: P::Input) -> Result<P::Output>

Run a compiler pass without an external cancellation check.

pub fn frontend_passes(&mut self) -> Result<()>

Runs all frontend passes: NameValidation through StaticAnalyzing.

pub fn frontend_passes_with_check<C>( &mut self, should_continue: C, ) -> Result<()>

where C: FnMut() -> Result<()>,

Runs all frontend passes while checking whether the caller still wants the result.

pub fn intermediate_passes( &mut self, ) -> Result<(Program, IndexMap<String, Program>, Vec<CompiledInterface>)>

Runs the compiler stages.

Returns the generated ABIs (primary and imports), which are captured immediately after monomorphisation to ensure all types are resolved, but not yet lowered.

pub fn generate_library_interface_abis(&self) -> Vec<CompiledInterface>

Generates interface ABIs for a validated library.

Must be called after build_library() since it reads the resolved AST.

pub fn compile( &mut self, source: &str, filename: FileName, modules: &Vec<(&str, FileName)>, ) -> Result<Compiled>

Compiles a program from a given source string and a list of module sources.

Arguments

• source - The main source code as a string slice.
• filename - The name of the main source file.
• modules - A vector of tuples where each tuple contains:
  • A module source as a string slice.
  • Its associated FileName.

Returns

• Ok(CompiledPrograms) containing the generated bytecode and ABI if compilation succeeds.
• Err(CompilerError) if any stage of the pipeline fails.

pub fn compile_from_directory( &mut self, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, ) -> Result<Compiled>

Compiles a program from a source file and its associated module files in the same directory tree.

pub fn compile_from_directory_with_file_source( &mut self, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, file_source: &impl FileSource, ) -> Result<Compiled>

Compiles a program from a source file using the given file source.

pub fn parse_program_from_directory( &mut self, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, ) -> Result<Program>

Parses a program from a source file and its associated module files in the same directory tree.

pub fn parse_program_from_directory_with_file_source( &mut self, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, file_source: &impl FileSource, ) -> Result<Program>

Parses a program from a source file using the given file source.

pub fn parse_library_from_directory( &mut self, library_name: Symbol, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, ) -> Result<Library>

Parses a program from a source file and its associated module files in the same directory tree.

pub fn parse_library_from_directory_with_file_source( &mut self, library_name: Symbol, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, file_source: &impl FileSource, ) -> Result<Library>

Parses a library from a source file.

pub fn add_import_stubs(&mut self) -> Result<()>

Resolves and registers all import stubs for the current program.

This method performs a graph traversal over the program’s import relationships to:

1. Establish parent–child relationships between stubs based on imports.
2. Collect all reachable stubs in traversal order.
3. Store the explored stubs back into self.state.ast.ast.stubs.

The traversal starts from the imports of the main program and recursively follows their transitive dependencies. Any missing stub during traversal results in an error.

Returns

• Ok(()) if all imports are successfully resolved and stubs are collected.
• Err(CompilerError) if any imported program cannot be found.

pub fn build_library( &mut self, library_name: Symbol, source: &str, filename: FileName, modules: &[(&str, FileName)], ) -> Result<Library>

Builds a library: parses the source, resolves import stubs, and runs all frontend passes.

Unlike Self::compile, this does not run monomorphisation, lowerings, or code generation. No bytecode is produced. Returns the validated library AST, which callers can convert into a Stub for downstream units in the same build graph.

pub fn build_library_from_directory( &mut self, library_name: Symbol, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, ) -> Result<Library>

Builds a library from a source file and its associated module files in the same directory tree.

pub fn build_library_from_directory_with_file_source( &mut self, library_name: Symbol, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, file_source: &impl FileSource, ) -> Result<Library>

Builds a library from a source file using the given file source.