Struct foundry_compilers::artifacts::Settings

pub struct Settings {
    pub stop_after: Option<String>,
    pub remappings: Vec<Remapping>,
    pub optimizer: Optimizer,
    pub model_checker: Option<ModelCheckerSettings>,
    pub metadata: Option<SettingsMetadata>,
    pub output_selection: OutputSelection,
    pub evm_version: Option<EvmVersion>,
    pub via_ir: Option<bool>,
    pub debug: Option<DebuggingSettings>,
    pub libraries: Libraries,
}

Fields

stop_after: Option<String>

Stop compilation after the given stage. since 0.8.11: only “parsing” is valid here

remappings: Vec<Remapping>

optimizer: Optimizer

Custom Optimizer settings

model_checker: Option<ModelCheckerSettings>

Model Checker options.

metadata: Option<SettingsMetadata>

Metadata settings

output_selection: OutputSelection

This field can be used to select desired outputs based on file and contract names. If this field is omitted, then the compiler loads and does type checking, but will not generate any outputs apart from errors.

evm_version: Option<EvmVersion>

via_ir: Option<bool>

Change compilation pipeline to go through the Yul intermediate representation. This is false by default.

debug: Option<DebuggingSettings>

libraries: Libraries

Addresses of the libraries. If not all libraries are given here, it can result in unlinked objects whose output data is different.

The top level key is the name of the source file where the library is used. If remappings are used, this source file should match the global path after remappings were applied. If this key is an empty string, that refers to a global level.

Implementations

impl Settings

pub fn new(output_selection: impl Into<OutputSelection>) -> Self

Creates a new Settings instance with the given output_selection

pub fn sanitized(self, version: &Version) -> Self

Consumes the type and returns a Settings::sanitize version

pub fn sanitize(&mut self, version: &Version)

This will remove/adjust values in the settings that are not compatible with this version.

pub fn push_all( &mut self, settings: impl IntoIterator<Item = ContractOutputSelection>, )

Inserts a set of ContractOutputSelection

pub fn with_extra_output( self, settings: impl IntoIterator<Item = ContractOutputSelection>, ) -> Self

Inserts a set of ContractOutputSelection

pub fn push_output_selection(&mut self, value: impl ToString)

Inserts the value for all files and contracts

use foundry_compilers::artifacts::{output_selection::ContractOutputSelection, Settings};
let mut selection = Settings::default();
selection.push_output_selection(ContractOutputSelection::Metadata);

pub fn push_contract_output_selection( &mut self, contracts: impl Into<String>, value: impl ToString, )

Inserts the key value pair to the output_selection for all files

If the key already exists, then the value is added to the existing list

pub fn set_output_selection( &mut self, values: impl IntoIterator<Item = impl ToString>, )

Sets the value for all files and contracts

pub fn set_contract_output_selection( &mut self, key: impl Into<String>, values: impl IntoIterator<Item = impl ToString>, )

Sets the key to the values pair to the output_selection for all files

This will replace the existing values for key if they’re present

pub fn set_via_ir(self, via_ir: bool) -> Self

Sets the viaIR value.

pub fn with_via_ir(self) -> Self

Enables viaIR.

pub fn with_via_ir_minimum_optimization(self) -> Self

Enable viaIR and use the minimum optimization settings.

This is useful in the following scenarios:

• When compiling for test coverage, this can resolve the “stack too deep” error while still giving a relatively accurate source mapping
• When compiling for test, this can reduce the compilation time

pub fn with_ast(self) -> Self

Adds ast to output

pub fn strip_prefix(&mut self, base: impl AsRef<Path>)

pub fn with_base_path(self, base: impl AsRef<Path>) -> Self

Strips base from all paths

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompilerSettings for Settings

fn update_output_selection( &mut self, f: impl FnOnce(&mut OutputSelection) + Copy, )

Executes given fn with mutable reference to configured OutputSelection.

fn can_use_cached(&self, other: &Self) -> bool

Returns true if artifacts compiled with given other config are compatible with this config and if compilation can be skipped.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Settings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MultiCompilerSettings> for Settings

fn from(settings: MultiCompilerSettings) -> Self

Converts to this type from the input type.

impl From<SolcConfig> for Settings

fn from(config: SolcConfig) -> Self

Converts to this type from the input type.

impl PartialEq for Settings

fn eq(&self, other: &Settings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Settings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Settings

impl StructuralPartialEq for Settings