Struct CompileOpts 

pub struct CompileOpts {

    pub input: Vec<String>,
    pub import_remappings: Vec<ImportRemapping>,
    pub base_path: Option<PathBuf>,
    pub include_paths: Vec<PathBuf>,
    pub allow_paths: Vec<PathBuf>,
    pub language: Language,
    pub threads: Threads,
    pub evm_version: EvmVersion,
    pub stop_after: Option<CompilerStage>,
    pub optimization: OptimizationMode,
    pub out_dir: Option<PathBuf>,
    pub emit: Vec<CompilerOutput>,
    pub standard_json: bool,
    pub color: ColorChoice,
    pub verbose: bool,
    pub pretty_json: bool,
    pub pretty_json_err: bool,
    pub error_format: ErrorFormat,
    pub error_format_human: HumanEmitterKind,
    pub diagnostic_width: Option<usize>,
    pub no_warnings: bool,
    pub allow: Vec<String>,
    pub unstable: UnstableOpts,
    /* private fields */
}

Available on crate feature cli only.

Compilation configuration.

Fields

input: Vec<String>

Files to compile, or import remappings.

- specifies standard input.

In Standard JSON mode, no input or - reads from standard input; otherwise, exactly one input file may be specified.

Import remappings are specified as [context:]prefix=path. See https://docs.soliditylang.org/en/latest/path-resolution.html#import-remapping.

import_remappings: Vec<ImportRemapping>

Import remappings.

This is either added manually when constructing the session or parsed from input into this field.

See https://docs.soliditylang.org/en/latest/path-resolution.html#import-remapping.

base_path: Option<PathBuf>

Use the given path as the root of the source tree.

include_paths: Vec<PathBuf>

Directory to search for files.

Can be used multiple times.

allow_paths: Vec<PathBuf>

Allow a given path for imports.

language: Language

Source code language. Only Solidity is currently implemented.

threads: Threads

Number of threads to use. Zero specifies the number of logical cores.

evm_version: EvmVersion

EVM version.

stop_after: Option<CompilerStage>

Stop execution after the given compiler stage.

optimization: OptimizationMode

MIR optimization objective.

out_dir: Option<PathBuf>

Directory to write output files.

emit: Vec<CompilerOutput>

Comma separated list of types of output for the compiler to emit.

standard_json: bool

Switch to Standard JSON input/output mode.

color: ColorChoice

Coloring.

verbose: bool

Use verbose output.

pretty_json: bool

Pretty-print JSON output.

Does not include errors. See --pretty-json-err.

pretty_json_err: bool

Pretty-print error JSON output.

error_format: ErrorFormat

How errors and other messages are produced.

error_format_human: HumanEmitterKind

Human-readable error message style.

diagnostic_width: Option<usize>

Terminal width for error message formatting.

no_warnings: bool

Whether to disable warnings.

allow: Vec<String>

Comma separated list of diagnostic codes to allow.

unstable: UnstableOpts

Parsed unstable flags.

Implementations

impl CompileOpts

pub const fn optimize_mir(&self) -> bool

Returns whether MIR optimization passes should run during codegen.

pub fn threads(&self) -> NonZero<usize>

Returns the number of threads to use.

pub fn finish(&mut self) -> Result<(), Error>

Available on crate feature clap only.

Finishes argument parsing.

Trait Implementations

impl Args for CompileOpts

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for CompileOpts

fn clone(&self) -> CompileOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for CompileOpts

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for CompileOpts

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

Formats the value using the given formatter.

impl Default for CompileOpts

fn default() -> CompileOpts

Returns the “default value” for a type.

impl FromArgMatches for CompileOpts

fn from_arg_matches( __clap_arg_matches: &ArgMatches, ) -> Result<CompileOpts, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<CompileOpts, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CompileOpts

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.