Struct Options 

pub struct Options {

    pub manifest_path: Option<PathBuf>,
    pub name: Option<String>,
    pub entrypoint: Option<String>,
    pub profile: String,
    pub workspace: bool,
    pub packages: Vec<String>,
    pub target: Option<String>,
    pub target_type: Option<TargetType>,
    pub optimize: OptLevel,
    pub debug: DebugInfo,
    pub output_types: OutputTypes,
    pub search_paths: Vec<PathBuf>,
    pub link_libraries: Vec<LinkLibrary>,
    pub link_modules: Vec<(PathBuf, String)>,
    pub sysroot: Option<PathBuf>,
    pub midenup_home: Option<PathBuf>,
    pub toolchain: Option<String>,
    pub color: ColorChoice,
    pub diagnostics: DiagnosticsConfig,
    pub current_dir: PathBuf,
    pub target_dir: PathBuf,
    pub output_dir: Option<PathBuf>,
    pub output_file: Option<OutputFile>,
    pub remap_path_prefixes: Vec<RemapPathPrefix>,
    pub print_hir_source_locations: bool,
    pub stop_after: Option<String>,
    pub parse_only: bool,
    pub analyze_only: bool,
    pub link_only: bool,
    pub no_link: bool,
    pub lint: bool,
    pub print_cfg_after_all: bool,
    pub print_cfg_after_pass: Vec<String>,
    pub print_ir_before_stage: Vec<String>,
    pub print_ir_after_all: bool,
    pub print_ir_after_pass: Vec<String>,
    pub print_ir_after_modified: bool,
    pub print_ir_filters: Vec<IrFilter>,
    pub save_temps: bool,
    pub rustflags: Option<String>,
    pub cargo_frontmatter: bool,
    pub flags: CompileFlags,
}

This struct contains all of the configuration options for the compiler

Fields

manifest_path: Option<PathBuf>

The path to the current project manifest, if present

name: Option<String>

The name of the program being compiled

entrypoint: Option<String>

The name of the function to call as the entrypoint

profile: String

The name of the build profile to use

workspace: bool

Build all packages in the current workspace (used by cargo miden)

packages: Vec<String>

Build the specified packages in the current workspace (used by cargo miden)

target: Option<String>

The name of the current project target being compiled

target_type: Option<TargetType>

The type of target that was requested

optimize: OptLevel

The optimization level for the current program

debug: DebugInfo

The level of debugging info for the current program

output_types: OutputTypes

The type of outputs to emit

search_paths: Vec<PathBuf>

The paths in which to search for Miden Assembly libraries to link against

link_libraries: Vec<LinkLibrary>

The set of Miden libraries to link against

link_modules: Vec<(PathBuf, String)>

A set of Miden Assembly modules to link against

sysroot: Option<PathBuf>

The path to the current toolchain directory, which contains libraries and other tools that the compiler may use.

This is expected to be set by midenup when the compiler is invoked via miden CLI

midenup_home: Option<PathBuf>

The path to midenup’s home directory

This is expected to be set by midenup when the compiler is invoked via miden CLI

toolchain: Option<String>

The name of the current midenup toolchain

This is expected to be set by midenup when the compiler is invoked via miden CLI

color: ColorChoice

Whether, and how, to color terminal output

diagnostics: DiagnosticsConfig

The current diagnostics configuration

current_dir: PathBuf

The current working directory of the compiler

target_dir: PathBuf

The target directory of the compiler

output_dir: Option<PathBuf>

The artifact output directory of the compiler

output_file: Option<OutputFile>

The output file requested by the user, if requested

remap_path_prefixes: Vec<RemapPathPrefix>

Path prefixes to remap for any file paths encoded in debug info

print_hir_source_locations: bool

Print source location information in HIR output

stop_after: Option<String>

Stop compilation after the named checkpoint, as --stop-after asked.

An alias declared by the route being compiled — parse, analyze, transform, lower, assemble — or a fully-qualified checkpoint id such as hir.initial. Which names are valid depends on the frontend the input selects, so the value is carried uninterpreted and resolved against that route once it is known; an unrecognized one is reported there, listing the names that route does accept.

This is the general form of the -C stop flags below, and naming both is a usage error rather than a precedence rule.

parse_only: bool

Only parse inputs

analyze_only: bool

Only perform semantic analysis on the input

link_only: bool

Run the linker on the inputs, but do not generate Miden Assembly

no_link: bool

Generate Miden Assembly from the inputs without the linker

lint: bool

Run the experimental Miden Assembly linter prior to codegen

This linter uses the HIR dataflow analysis framework to check for issues such as unconstrained advice usage.

print_cfg_after_all: bool

Print CFG to stdout after each pass

print_cfg_after_pass: Vec<String>

Print CFG to stdout each time the named passes are applied

print_ir_before_stage: Vec<String>

Print IR to stdout at the start of each stage

print_ir_after_all: bool

Print IR to stdout after each pass

print_ir_after_pass: Vec<String>

Print IR to stdout each time the named passes are applied

print_ir_after_modified: bool

Only print the IR if the pass modified the IR structure.

print_ir_filters: Vec<IrFilter>

Apply filters to what IR is printed, when printing is enabled

save_temps: bool

Save intermediate artifacts in memory during compilation

rustflags: Option<String>

Custom RUSTFLAGS to set when building Rust

cargo_frontmatter: bool

Look for cargo -Zscript-style frontmatter when compiling standalone Rust sources

flags: CompileFlags

We store any leftover argument matches in the session options for use by any downstream crates that register custom flags

Implementations

impl Options

pub fn new( name: Option<String>, target: Option<TargetType>, current_dir: PathBuf, target_dir: PathBuf, output_dir: Option<PathBuf>, sysroot: Option<PathBuf>, ) -> Self

pub fn with_color(self: Box<Self>, color: ColorChoice) -> Box<Self>

pub fn with_verbosity(self: Box<Self>, verbosity: Verbosity) -> Box<Self>

pub fn with_debug_info(self: Box<Self>, debug: DebugInfo) -> Box<Self>

pub fn with_optimization(self: Box<Self>, level: OptLevel) -> Box<Self>

pub fn with_warnings(self: Box<Self>, warnings: Warnings) -> Box<Self>

pub fn with_output_types( self: Box<Self>, output_types: OutputTypes, output_file: Option<OutputFile>, ) -> Box<Self>

pub fn into_session( self: Box<Self>, input: InputFile, emitter: Option<Arc<dyn Emitter>>, source_manager: Option<Arc<dyn SourceManager + Send + Sync>>, ) -> Result<Session, Report>

Use this configuration to obtain a crate::Session used for compilation

pub fn default_emitter(&self) -> Arc<dyn Emitter>

Get a new Emitter based on the current options.

pub fn emit_source_locations(&self) -> bool

Returns true if source location information should be emitted by the compiler

pub fn emit_debug_decorators(&self) -> bool

Returns true if rich debugging information should be emitted by the compiler. This enables AssemblyOp decorators which carry source location info for runtime errors.

pub fn emit_debug_assertions(&self) -> bool

Returns true if debug assertions are enabled

pub fn target_requires_protocol(&self) -> bool

Returns true if the requested target type is a protocol target

pub fn quiet(&self) -> bool

Returns true if the requested verbosity level is silent

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.