Trait foundry_compilers::compilers::CompilerInput

source ·
pub trait CompilerInput: Serialize + Send + Sync + Sized {
    type Settings: CompilerSettings;

    // Required methods
    fn build(
        sources: Sources,
        settings: Self::Settings,
        version: &Version
    ) -> Vec<Self>;
    fn sources(&self) -> &Sources;
    fn compiler_name(&self) -> String;
    fn strip_prefix(&mut self, base: &Path);

    // Provided method
    fn with_remappings(self, _remappings: Vec<Remapping>) -> Self { ... }
}
Expand description

Input of a compiler, including sources and settings used for their compilation.

Required Associated Types§

Required Methods§

source

fn build( sources: Sources, settings: Self::Settings, version: &Version ) -> Vec<Self>

Constructs one or multiple inputs from given sources set. Might return multiple inputs in cases when sources need to be divided into sets per language (Yul + Solidity for example).

source

fn sources(&self) -> &Sources

Returns reference to sources included into this input.

source

fn compiler_name(&self) -> String

Returns compiler name used by reporters to display output during compilation.

source

fn strip_prefix(&mut self, base: &Path)

Strips given prefix from all paths.

Provided Methods§

source

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

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

Object Safety§

This trait is not object safe.

Implementors§