Struct foundry_compilers::ProjectCompileOutput

pub struct ProjectCompileOutput<C: Compiler = MultiCompiler, T: ArtifactOutput = ConfigurableArtifacts> { /* private fields */ }

Contains a mixture of already compiled/cached artifacts and the input set of sources that still need to be compiled.

Implementations

impl<T: ArtifactOutput, C: Compiler> ProjectCompileOutput<C, T>

pub fn slash_paths(&mut self)

Converts all \\ separators in all paths to /

pub fn with_slashed_paths(self) -> Self

Convenience function fo Self::slash_paths()

pub fn artifact_ids( &self, ) -> impl Iterator<Item = (ArtifactId, &T::Artifact)> + '_

All artifacts together with their contract file name and name <file name>:<name>.

This returns a chained iterator of both cached and recompiled contract artifacts.

Borrowed version of Self::into_artifacts.

pub fn into_artifacts(self) -> impl Iterator<Item = (ArtifactId, T::Artifact)>

All artifacts together with their contract file name and name <file name>:<name>

This returns a chained iterator of both cached and recompiled contract artifacts

Examples

use foundry_compilers::{ArtifactId, ConfigurableContractArtifact, Project};
use std::collections::btree_map::BTreeMap;

let project = Project::builder().build()?;
let contracts: BTreeMap<ArtifactId, ConfigurableContractArtifact> =
    project.compile()?.into_artifacts().collect();

pub fn artifacts(&self) -> impl Iterator<Item = (String, &T::Artifact)>

This returns a chained iterator of both cached and recompiled contract artifacts that yields the contract name and the corresponding artifact

Examples

use foundry_compilers::{ConfigurableContractArtifact, Project};
use std::collections::btree_map::BTreeMap;

let project = Project::builder().build()?;
let artifacts: BTreeMap<String, &ConfigurableContractArtifact> =
    project.compile()?.artifacts().collect();

pub fn versioned_artifacts( &self, ) -> impl Iterator<Item = (String, (&T::Artifact, &Version))>

This returns a chained iterator of both cached and recompiled contract artifacts that yields the contract name and the corresponding artifact with its version

Examples

use foundry_compilers::{ConfigurableContractArtifact, Project};
use semver::Version;
use std::collections::btree_map::BTreeMap;

let project = Project::builder().build()?;
let artifacts: BTreeMap<String, (&ConfigurableContractArtifact, &Version)> =
    project.compile()?.versioned_artifacts().collect();

pub fn artifacts_with_files( &self, ) -> impl Iterator<Item = (&PathBuf, &String, &T::Artifact)> + '_

All artifacts together with their contract file and name as tuple (file, contract name, artifact)

This returns a chained iterator of both cached and recompiled contract artifacts

Borrowed version of Self::into_artifacts_with_files.

NOTE the file will be returned as is, see also Self::with_stripped_file_prefixes().

pub fn into_artifacts_with_files( self, ) -> impl Iterator<Item = (PathBuf, String, T::Artifact)>

All artifacts together with their contract file and name as tuple (file, contract name, artifact)

This returns a chained iterator of both cached and recompiled contract artifacts

Examples

use foundry_compilers::{ConfigurableContractArtifact, Project};
use std::collections::btree_map::BTreeMap;

let project = Project::builder().build()?;
let contracts: Vec<(String, String, ConfigurableContractArtifact)> =
    project.compile()?.into_artifacts_with_files().collect();

NOTE the file will be returned as is, see also Self::with_stripped_file_prefixes()

pub fn into_artifacts_with_sources( self, ) -> (BTreeMap<ArtifactId, T::Artifact>, VersionedSourceFiles)

All artifacts together with their ID and the sources of the project.

Note: this only returns the SourceFiles for freshly compiled contracts because, if not included in the Artifact itself (see foundry_compilers_artifacts::ConfigurableContractArtifact::source_file()), is only available via the solc CompilerOutput

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

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

Examples

Make all artifact files relative to the project’s root directory

use foundry_compilers::Project;

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

pub fn output(&self) -> &AggregatedCompilerOutput<C>

Returns a reference to the (merged) solc compiler output.

Examples

use foundry_compilers::{artifacts::contract::Contract, Project};
use std::collections::btree_map::BTreeMap;

let project = Project::builder().build()?;
let contracts: BTreeMap<String, Contract> =
    project.compile()?.into_output().contracts_into_iter().collect();

pub fn output_mut(&mut self) -> &mut AggregatedCompilerOutput<C>

Returns a mutable reference to the (merged) solc compiler output.

pub fn into_output(self) -> AggregatedCompilerOutput<C>

Consumes the output and returns the (merged) solc compiler output.

pub fn has_compiled_contracts(&self) -> bool

Returns whether this type has a compiler output.

pub fn is_unchanged(&self) -> bool

Returns whether this type does not contain compiled contracts.

pub fn cached_artifacts(&self) -> &Artifacts<T::Artifact>

Returns the set of Artifacts that were cached and got reused during crate::Project::compile()

pub fn compiled_artifacts(&self) -> &Artifacts<T::Artifact>

Returns the set of Artifacts that were compiled with solc in crate::Project::compile()

pub fn set_compiled_artifacts( &mut self, new_compiled_artifacts: Artifacts<T::Artifact>, )

Sets the compiled artifacts for this output.

pub fn compiled_contracts_by_compiler_version( &self, ) -> BTreeMap<Version, Vec<(String, Contract)>>

Returns a BTreeMap that maps the compiler version used during crate::Project::compile() to a Vector of tuples containing the contract name and the Contract

pub fn find_contract<'a>( &self, info: impl Into<ContractInfoRef<'a>>, ) -> Option<&T::Artifact>

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()?;
let output = project.compile()?;
let info = ContractInfo::new("src/Greeter.sol:Greeter");
let contract = output.find_contract(&info).unwrap();

pub fn find( &self, path: impl AsRef<str>, contract: impl AsRef<str>, ) -> Option<&T::Artifact>

Finds the artifact with matching path and name

Examples

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

let project = Project::builder().build()?;
let output = project.compile()?;
let contract = output.find("src/Greeter.sol", "Greeter").unwrap();

pub fn find_first(&self, contract_name: impl AsRef<str>) -> Option<&T::Artifact>

Finds the first contract with the given name

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

Finds the artifact with matching path and name

Examples

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

let project = Project::builder().build()?;
let output = project.compile()?;
let contract = output.find("src/Greeter.sol", "Greeter").unwrap();

pub fn remove_first( &mut self, contract_name: impl AsRef<str>, ) -> Option<T::Artifact>

Removes the first contract with the given name from the set

Examples

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

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

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

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()?;
let mut output = project.compile()?;
let info = ContractInfo::new("src/Greeter.sol:Greeter");
let contract = output.remove_contract(&info).unwrap();

pub fn into_contract_bytecodes( self, ) -> impl Iterator<Item = (ArtifactId, CompactContractBytecode)>

A helper functions that extracts the underlying CompactContractBytecode from the foundry_compilers_artifacts::ConfigurableContractArtifact

Examples

use foundry_compilers::{
    artifacts::contract::CompactContractBytecode, contracts::ArtifactContracts, ArtifactId,
    Project,
};
use std::collections::btree_map::BTreeMap;

let project = Project::builder().build()?;
let contracts: ArtifactContracts = project.compile()?.into_contract_bytecodes().collect();

pub fn builds( &self, ) -> impl Iterator<Item = (&String, &BuildContext<C::Language>)>

impl<C: Compiler, T: ArtifactOutput> ProjectCompileOutput<C, T>

pub fn has_compiler_errors(&self) -> bool

Returns whether any errors were emitted by the compiler.

pub fn has_compiler_warnings(&self) -> bool

Returns whether any warnings were emitted by the compiler.

pub fn succeeded(self) -> Self

Panics if any errors were emitted by the compiler.

pub fn assert_success(&self)

Panics if any errors were emitted by the compiler.

Trait Implementations

impl<C: Clone + Compiler, T: Clone + ArtifactOutput> Clone for ProjectCompileOutput<C, T>

where T::Artifact: Clone, C::Language: Clone,

fn clone(&self) -> ProjectCompileOutput<C, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + Compiler, T: Debug + ArtifactOutput> Debug for ProjectCompileOutput<C, T>

where T::Artifact: Debug, C::Language: Debug,

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

Formats the value using the given formatter.

impl<C: Default + Compiler, T: Default + ArtifactOutput> Default for ProjectCompileOutput<C, T>

where T::Artifact: Default, C::Language: Default,

fn default() -> ProjectCompileOutput<C, T>

Returns the “default value” for a type.

impl<C: Compiler, T: ArtifactOutput> Display for ProjectCompileOutput<C, T>

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

Formats the value using the given formatter.

impl<C: PartialEq + Compiler, T: PartialEq + ArtifactOutput> PartialEq for ProjectCompileOutput<C, T>

where T::Artifact: PartialEq, C::Language: PartialEq,

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C: Compiler, T: ArtifactOutput> StructuralPartialEq for ProjectCompileOutput<C, T>