Struct BuildOpts 

pub struct BuildOpts {

    pub force: bool,
    pub no_cache: bool,
    pub dynamic_test_linking: bool,
    pub libraries: Vec<String>,
    pub ignored_error_codes: Vec<u64>,
    pub deny: Option<DenyLevel>,
    pub deny_warnings: bool,
    pub no_auto_detect: bool,
    pub use_solc: Option<String>,
    pub offline: bool,
    pub via_ir: bool,
    pub use_literal_content: bool,
    pub no_metadata: bool,
    pub out_path: Option<PathBuf>,
    pub revert_strings: Option<RevertStrings>,
    pub build_info: bool,
    pub build_info_path: Option<PathBuf>,
    pub skip: Option<Vec<SkipBuildFilter>>,
    pub compiler: CompilerOpts,
    pub project_paths: ProjectPathOpts,
}

Fields

force: bool

Clear the cache and artifacts folder and recompile.

no_cache: bool

Disable the cache.

dynamic_test_linking: bool

Enable dynamic test linking.

libraries: Vec<String>

Set pre-linked libraries.

ignored_error_codes: Vec<u64>

Ignore solc warnings by error code.

deny: Option<DenyLevel>

A compiler error will be triggered at the specified diagnostic level.

Replaces the deprecated --deny-warnings flag.

Possible values:

• never: Do not treat any diagnostics as errors.
• warnings: Treat warnings as errors.
• notes: Treat both, warnings and notes, as errors.

deny_warnings: bool

Deprecated: use --deny=warnings instead.

no_auto_detect: bool

Do not auto-detect the solc version.

use_solc: Option<String>

Specify the solc version, or a path to a local solc, to build with.

Valid values are in the format x.y.z, solc:x.y.z or path/to/solc.

offline: bool

Do not access the network.

Missing solc versions will not be installed.

via_ir: bool

Use the Yul intermediate representation compilation pipeline.

use_literal_content: bool

Changes compilation to only use literal content and not URLs.

no_metadata: bool

Do not append any metadata to the bytecode.

This is equivalent to setting bytecode_hash to none and cbor_metadata to false.

out_path: Option<PathBuf>

The path to the contract artifacts folder.

revert_strings: Option<RevertStrings>

Revert string configuration.

Possible values are “default”, “strip” (remove), “debug” (Solidity-generated revert strings) and “verboseDebug”

build_info: bool

Generate build info files.

build_info_path: Option<PathBuf>

Output path to directory that build info files will be written to.

skip: Option<Vec<SkipBuildFilter>>

Skip building files whose names contain the given filter.

test and script are aliases for .t.sol and .s.sol.

compiler: CompilerOpts

project_paths: ProjectPathOpts

Implementations

impl BuildOpts

pub fn project(&self) -> Result<Project<MultiCompiler>>

Returns the Project for the current workspace

This loads the foundry_config::Config for the current workspace (see find_project_root and merges the cli BuildArgs into it before returning [foundry_config::Config::project()]).

pub fn get_remappings(&self) -> Vec<Remapping>

👎Deprecated: Use ProjectPathsArgs::get_remappings() instead

Returns the remappings to add to the config

Trait Implementations

impl Args for BuildOpts

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::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 BuildOpts

fn clone(&self) -> BuildOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for BuildOpts

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 BuildOpts

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

Formats the value using the given formatter.

impl Default for BuildOpts

fn default() -> BuildOpts

Returns the “default value” for a type.

impl<'a> From<&'a BuildOpts> for Figment

fn from(args: &'a BuildOpts) -> Self

Converts to this type from the input type.

impl FromArgMatches for BuildOpts

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

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, 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 BuildOpts

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::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][Error::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][Error::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.

impl Provider for BuildOpts

fn metadata(&self) -> Metadata

Returns the [Metadata] for this provider, identifying itself and its configuration sources.

fn data(&self) -> Result<Map<Profile, Dict>, Error>

Returns the configuration data.

fn profile(&self) -> Option<Profile>

Optionally returns a profile to set on the Figment this provider is merged into. The profile is only set if self is merged.

impl Serialize for BuildOpts

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 408 bytes