Struct midenc_session::Options

pub struct Options {

    pub name: Option<String>,
    pub project_type: ProjectType,
    pub entrypoint: Option<String>,
    pub target: TargetEnv,
    pub optimize: OptLevel,
    pub debug: DebugInfo,
    pub output_types: OutputTypes,
    pub search_paths: Vec<PathBuf>,
    pub link_libraries: Vec<LinkLibrary>,
    pub sysroot: Option<PathBuf>,
    pub color: ColorChoice,
    pub diagnostics: DiagnosticsConfig,
    pub current_dir: PathBuf,
    pub parse_only: bool,
    pub analyze_only: bool,
    pub link_only: bool,
    pub no_link: bool,
    pub print_cfg_after_all: bool,
    pub print_cfg_after_pass: Vec<String>,
    pub print_ir_after_all: bool,
    pub print_ir_after_pass: Vec<String>,
    pub save_temps: bool,
    pub flags: CompileFlags,
}

This struct contains all of the configuration options for the compiler

Fields

name: Option<String>

The name of the program being compiled

project_type: ProjectType

The type of project we’re compiling this session

entrypoint: Option<String>

The name of the function to call as the entrypoint

target: TargetEnv

The current target environment for this session

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

sysroot: Option<PathBuf>

The location of the libraries which are shipped with the compiler

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

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

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_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

save_temps: bool

Save intermediate artifacts in memory during compilation

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: TargetEnv, project_type: ProjectType, current_dir: PathBuf, sysroot: Option<PathBuf>, ) -> Self

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

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

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

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

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

pub fn with_output_types(self, output_types: OutputTypes) -> Self

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

pub fn emit_debug_assertions(&self) -> bool

Returns true if debug assertions are enabled

Trait Implementations

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.