Struct ProjectCompiler

pub struct ProjectCompiler<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler> { /* private fields */ }

Implementations

impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler> ProjectCompiler<'a, T, C>

pub fn new(project: &'a Project<C, T>) -> Result<Self>

Create a new ProjectCompiler to bootstrap the compilation process of the project’s sources.

pub fn with_sources( project: &'a Project<C, T>, sources: Sources, ) -> Result<Self>

Bootstraps the compilation process by resolving the dependency graph of all sources and the appropriate Solc -> Sources set as well as the compile mode to use (parallel, sequential)

Multiple (Solc -> Sources) pairs can be compiled in parallel if the Project allows multiple jobs, see crate::Project::set_solc_jobs().

pub fn with_preprocessor( self, preprocessor: impl Preprocessor<C> + 'static, ) -> Self

pub fn compile(self) -> Result<ProjectCompileOutput<C, T>>

Compiles all the sources of the Project in the appropriate mode

If caching is enabled, the sources are filtered and only dirty sources are recompiled.

The output of the compile process can be a mix of reused artifacts and freshly compiled Contracts

Examples

use foundry_compilers::Project;

let project = Project::builder().build(Default::default())?;
let output = project.compile()?;

Trait Implementations

impl<'a, T: Debug + ArtifactOutput<CompilerContract = C::CompilerContract>, C: Debug + Compiler> Debug for ProjectCompiler<'a, T, C>

where C::ParsedSource: Debug, C::Language: Debug, C::Settings: Debug,

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

Formats the value using the given formatter.