Struct AggregatedCompilerOutput

pub struct AggregatedCompilerOutput<C: Compiler> {
    pub errors: Vec<C::CompilationError>,
    pub sources: VersionedSourceFiles,
    pub contracts: VersionedContracts<C::CompilerContract>,
    pub build_infos: Vec<RawBuildInfo<C::Language>>,
}

The aggregated output of (multiple) compile jobs

This is effectively a solc version aware CompilerOutput

Fields

errors: Vec<C::CompilationError>

all errors from all CompilerOutput

sources: VersionedSourceFiles

All source files combined with the solc version used to compile them

contracts: VersionedContracts<C::CompilerContract>

All compiled contracts combined with the solc version used to compile them

build_infos: Vec<RawBuildInfo<C::Language>>

Implementations

impl<C: Compiler> AggregatedCompilerOutput<C>

pub fn slash_paths(&mut self)

Converts all \\ separators in all paths to /

pub fn diagnostics<'a>( &'a self, ignored_error_codes: &'a [u64], ignored_file_paths: &'a [PathBuf], compiler_severity_filter: Severity, ) -> OutputDiagnostics<'a, C>

pub fn is_empty(&self) -> bool

pub fn is_unchanged(&self) -> bool

pub fn extend( &mut self, version: Version, build_info: RawBuildInfo<C::Language>, profile: &str, output: CompilerOutput<C::CompilationError, C::CompilerContract>, )

adds a new CompilerOutput to the aggregated output

pub fn write_build_infos(&self, build_info_dir: &Path) -> Result<(), SolcError>

Creates all BuildInfo files in the given build_info_dir

There can be multiple BuildInfo, since we support multiple versions.

The created files have a unique identifier as their name.

pub fn find_first(&self, contract: &str) -> Option<CompactContractRef<'_>>

Finds the first contract with the given name

Examples

use foundry_compilers::{artifacts::*, Project};

let project = Project::builder().build(Default::default())?;
let output = project.compile()?.into_output();
let contract = output.find_first("Greeter").unwrap();

pub fn remove_first(&mut self, contract: &str) -> Option<C::CompilerContract>

Removes the first contract with the given name from the set

Examples

use foundry_compilers::{artifacts::*, Project};

let project = Project::builder().build(Default::default())?;
let mut output = project.compile()?.into_output();
let contract = output.remove_first("Greeter").unwrap();

pub fn remove( &mut self, path: &Path, contract: &str, ) -> Option<C::CompilerContract>

Removes the contract with matching path and name

Examples

use foundry_compilers::{artifacts::*, Project};

let project = Project::builder().build(Default::default())?;
let mut output = project.compile()?.into_output();
let contract = output.remove("src/Greeter.sol".as_ref(), "Greeter").unwrap();

pub fn remove_contract<'a>( &mut self, info: impl Into<ContractInfoRef<'a>>, ) -> Option<C::CompilerContract>

Removes the contract with matching path and name using the <path>:<contractname> pattern where path is optional.

If the path segment is None, then the first matching Contract is returned, see Self::remove_first

Examples

use foundry_compilers::{artifacts::*, info::ContractInfo, Project};

let project = Project::builder().build(Default::default())?;
let mut output = project.compile()?.into_output();
let info = ContractInfo::new("src/Greeter.sol:Greeter");
let contract = output.remove_contract(&info).unwrap();

pub fn contracts_iter( &self, ) -> impl Iterator<Item = (&String, &C::CompilerContract)>

Iterate over all contracts and their names

pub fn contracts_into_iter( self, ) -> impl Iterator<Item = (String, C::CompilerContract)>

Iterate over all contracts and their names

pub fn contracts_with_files_iter( &self, ) -> impl Iterator<Item = (&PathBuf, &String, &C::CompilerContract)>

Returns an iterator over (file, name, Contract)

pub fn contracts_with_files_into_iter( self, ) -> impl Iterator<Item = (PathBuf, String, C::CompilerContract)>

Returns an iterator over (file, name, Contract)

pub fn contracts_with_files_and_version_iter( &self, ) -> impl Iterator<Item = (&PathBuf, &String, &C::CompilerContract, &Version)>

Returns an iterator over (file, name, Contract, Version)

pub fn contracts_with_files_and_version_into_iter( self, ) -> impl Iterator<Item = (PathBuf, String, C::CompilerContract, Version)>

Returns an iterator over (file, name, Contract, Version)

pub fn get(&self, path: &Path, contract: &str) -> Option<CompactContractRef<'_>>

Given the contract file’s path and the contract’s name, tries to return the contract’s bytecode, runtime bytecode, and ABI.

Examples

use foundry_compilers::{artifacts::*, Project};

let project = Project::builder().build(Default::default())?;
let output = project.compile()?.into_output();
let contract = output.get("src/Greeter.sol".as_ref(), "Greeter").unwrap();

pub fn split( self, ) -> (VersionedSourceFiles, VersionedContracts<C::CompilerContract>)

Returns the output’s source files and contracts separately, wrapped in helper types that provide several helper methods

Examples

use foundry_compilers::Project;

let project = Project::builder().build(Default::default())?;
let output = project.compile()?.into_output();
let (sources, contracts) = output.split();

pub fn join_all(&mut self, root: &Path) -> &mut Self

Joins all file path with root

pub fn with_stripped_file_prefixes(self, base: &Path) -> Self

Strips the given prefix from all file paths to make them relative to the given base argument.

Convenience method for Self::strip_prefix_all() that consumes the type.

Examples

Make all sources and contracts relative to the project’s root directory

use foundry_compilers::Project;

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

pub fn strip_prefix_all(&mut self, base: &Path) -> &mut Self

Removes base from all contract paths

impl<C: Compiler> AggregatedCompilerOutput<C>

pub fn has_error( &self, ignored_error_codes: &[u64], ignored_file_paths: &[PathBuf], compiler_severity_filter: &Severity, ) -> bool

Whether the output contains a compiler error

This adheres to the given compiler_severity_filter and also considers CompilationError with the given Severity as errors. For example Severity::Warning will consider CompilationErrors with Severity::Warning and Severity::Error as errors.

pub fn has_warning( &self, ignored_error_codes: &[u64], ignored_file_paths: &[PathBuf], ) -> bool

Checks if there are any compiler warnings that are not ignored by the specified error codes and file paths.

pub fn should_ignore( &self, ignored_error_codes: &[u64], ignored_file_paths: &[PathBuf], error: &C::CompilationError, ) -> bool

Trait Implementations

impl<C: Clone + Compiler> Clone for AggregatedCompilerOutput<C>

where C::CompilationError: Clone, C::CompilerContract: Clone, C::Language: Clone,

fn clone(&self) -> AggregatedCompilerOutput<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug + Compiler> Debug for AggregatedCompilerOutput<C>

where C::CompilationError: Debug, C::CompilerContract: Debug, C::Language: Debug,

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

Formats the value using the given formatter.

impl<C: Compiler> Default for AggregatedCompilerOutput<C>

fn default() -> Self

Returns the “default value” for a type.

impl<C: PartialEq + Compiler> PartialEq for AggregatedCompilerOutput<C>

where C::CompilationError: PartialEq, C::CompilerContract: PartialEq, C::Language: PartialEq,

fn eq(&self, other: &AggregatedCompilerOutput<C>) -> bool

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

const 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<C: Compiler> Serialize for AggregatedCompilerOutput<C>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C: Eq + Compiler> Eq for AggregatedCompilerOutput<C>

where C::CompilationError: Eq, C::CompilerContract: Eq, C::Language: Eq,

impl<C: Compiler> StructuralPartialEq for AggregatedCompilerOutput<C>