Struct SolcSettings

pub struct SolcSettings {
    pub settings: Settings,
    pub cli_settings: CliSettings,
}

Fields

settings: Settings

JSON settings expected by Solc

cli_settings: CliSettings

Additional CLI args configuration

Methods from Deref<Target = Settings>

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

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 push_output_selection(&mut self, value: impl ToString)

Inserts the value for all files and contracts

use foundry_compilers_artifacts_solc::{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 strip_prefix(&mut self, base: &Path)

Trait Implementations

impl Clone for SolcSettings

fn clone(&self) -> SolcSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CompilerSettings for SolcSettings

type Restrictions = SolcRestrictions

We allow configuring settings restrictions which might optionally contain specific requiremets for compiler configuration. e.g. min/max evm_version, optimizer runs

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.

fn with_remappings(self, remappings: &[Remapping]) -> Self

Method which might be invoked to add remappings to the input.

fn with_allow_paths(self, allowed_paths: &BTreeSet<PathBuf>) -> Self

Builder method to set the allowed paths for the compiler. Primarily used by solc implementation to set –allow-paths.

fn with_base_path(self, base_path: &Path) -> Self

Builder method to set the base path for the compiler. Primarily used by solc implementation to se –base-path.

fn with_include_paths(self, include_paths: &BTreeSet<PathBuf>) -> Self

Builder method to set the include paths for the compiler. Primarily used by solc implementation to set –include-paths.

fn satisfies_restrictions(&self, restrictions: &Self::Restrictions) -> bool

Returns whether current settings satisfy given restrictions.

impl Debug for SolcSettings

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

Formats the value using the given formatter.

impl Default for SolcSettings

fn default() -> SolcSettings

Returns the “default value” for a type.

impl Deref for SolcSettings

type Target = Settings

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for SolcSettings

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for SolcSettings

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 SolcSettings

fn from(settings: MultiCompilerSettings) -> Self

Converts to this type from the input type.

impl PartialEq for SolcSettings

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SolcSettings

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 SolcSettings

impl StructuralPartialEq for SolcSettings