Struct ethers_solc::AggregatedCompilerOutput

pub struct AggregatedCompilerOutput {
    pub errors: Vec<Error>,
    pub sources: VersionedSourceFiles,
    pub contracts: VersionedContracts,
}

The aggregated output of (multiple) compile jobs

This is effectively a solc version aware CompilerOutput

Fields

errors: Vec<Error>

all errors from all CompilerOutput

sources: VersionedSourceFiles

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

contracts: VersionedContracts

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

Implementations

impl AggregatedCompilerOutput

pub fn has_error(&self) -> bool

Whether the output contains a compiler error

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

Whether the output contains a compiler warning

pub fn diagnostics<'a>(
    &'a self,
    ignored_error_codes: &'a [u64]
) -> OutputDiagnostics<'_>

pub fn is_empty(&self) -> bool

pub fn is_unchanged(&self) -> bool

pub fn extend_all<I>(&mut self, out: I) where
    I: IntoIterator<Item = (Version, CompilerOutput)>, 

pub fn extend(&mut self, version: Version, output: CompilerOutput)

adds a new CompilerOutput to the aggregated output

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

Finds the first contract with the given name

Example

use ethers_solc::Project;
use ethers_solc::artifacts::*;
let output = project.compile().unwrap().output();
let contract = output.find("Greeter").unwrap();

pub fn remove(&mut self, contract: impl AsRef<str>) -> Option<Contract>

Removes the first contract with the given name from the set

Example

use ethers_solc::Project;
use ethers_solc::artifacts::*;
let mut output = project.compile().unwrap().output();
let contract = output.remove("Greeter").unwrap();

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

Iterate over all contracts and their names

pub fn contracts_into_iter(self) -> impl Iterator<Item = (String, Contract)>

Iterate over all contracts and their names

pub fn get(&self, path: &str, 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

pub fn split(self) -> (VersionedSourceFiles, VersionedContracts)

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

Example

use ethers_solc::Project;
let output = project.compile().unwrap().output();
let (sources, contracts) = output.split();

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

Joins all file path with root

pub fn with_stripped_file_prefixes(self, base: impl AsRef<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.

Example

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

use ethers_solc::Project;

let project = Project::builder().build().unwrap();
let output = project.compile().unwrap().output().with_stripped_file_prefixes(project.root());

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

Removes base from all contract paths

Trait Implementations

impl Clone for AggregatedCompilerOutput

fn clone(&self) -> AggregatedCompilerOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AggregatedCompilerOutput

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

Formats the value using the given formatter.

impl Default for AggregatedCompilerOutput

fn default() -> AggregatedCompilerOutput

Returns the “default value” for a type.

impl PartialEq<AggregatedCompilerOutput> for AggregatedCompilerOutput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for AggregatedCompilerOutput