Struct foundry_compilers::artifacts::CompilerInput

pub struct CompilerInput {
    pub language: String,
    pub sources: Sources,
    pub settings: Settings,
}

Input type solc expects.

Fields

language: String

sources: Sources

settings: Settings

Implementations

impl CompilerInput

pub fn new(path: impl AsRef<Path>) -> Result<Vec<Self>, SolcIoError>

Reads all contracts found under the path

pub fn with_sources(sources: Sources) -> Vec<Self>

Creates a new CompilerInputs with default settings and the given sources

A CompilerInput expects a language setting, supported by solc are solidity or yul. In case the sources is a mix of solidity and yul files, 2 CompilerInputs are returned

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

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

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

Consumes the type and returns a CompilerInput::sanitized version

pub fn settings(self, settings: Settings) -> Self

Sets the settings for compilation

pub fn evm_version(self, version: EvmVersion) -> Self

Sets the EVM version for compilation

pub fn optimizer(self, runs: usize) -> Self

Sets the optimizer runs (default = 200)

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

Normalizes the EVM version used in the settings to be up to the latest one supported by the provided compiler version.

pub fn with_remappings(self, remappings: Vec<Remapping>) -> Self

pub fn join_path(self, root: impl AsRef<Path>) -> Self

Sets the path of the source files to root adjoined to the existing path

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

Removes the base path from all source files

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

Similar to Self::strip_prefix(). Remove a base path from all sources and all paths in solc settings such as remappings

See also solc --base-path

pub fn is_yul(&self) -> bool

The flag indicating whether the current CompilerInput is constructed for the yul sources

Trait Implementations

impl Clone for CompilerInput

fn clone(&self) -> CompilerInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompilerInput

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

Formats the value using the given formatter.

impl Default for CompilerInput

Default language field is set to "Solidity".

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CompilerInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CompilerInput> for StandardJsonCompilerInput

fn from(input: CompilerInput) -> Self

Converts to this type from the input type.

impl From<StandardJsonCompilerInput> for CompilerInput

fn from(input: StandardJsonCompilerInput) -> Self

Converts to this type from the input type.

impl Serialize for CompilerInput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.