Struct CacheEntry

pub struct CacheEntry<S = Settings> {
    pub last_modification_date: u64,
    pub content_hash: String,
    pub source_name: PathBuf,
    pub compiler_settings: S,
    pub imports: BTreeSet<PathBuf>,
    pub version_requirement: Option<String>,
    pub artifacts: BTreeMap<String, BTreeMap<Version, CachedArtifact>>,
    pub seen_by_compiler: bool,
}

A CacheEntry in the cache file represents a solidity file

A solidity file can contain several contracts, for every contract a separate Artifact is emitted. so the CacheEntry tracks the artifacts by name. A file can be compiled with multiple solc versions generating version specific artifacts.

Fields

last_modification_date: u64

the last modification time of this file

content_hash: String

hash to identify whether the content of the file changed

source_name: PathBuf

identifier name see foundry_compilers_core::utils::source_name()

compiler_settings: S

what config was set when compiling this file

imports: BTreeSet<PathBuf>

fully resolved imports of the file

all paths start relative from the project’s root: src/importedFile.sol

version_requirement: Option<String>

The solidity version pragma

artifacts: BTreeMap<String, BTreeMap<Version, CachedArtifact>>

all artifacts produced for this file

In theory a file can be compiled by different solc versions: A(<=0.8.10) imports C(>0.4.0) and B(0.8.11) imports C(>0.4.0) file C would be compiled twice, with 0.8.10 and 0.8.11, producing two different artifacts.

This map tracks the artifacts by name -> (Version -> PathBuf). This mimics the default artifacts directory structure

seen_by_compiler: bool

Whether this file was compiled at least once.

If this is true and artifacts are empty, it means that given version of the file does not produce any artifacts and it should not be compiled again.

If this is false, then artifacts are definitely empty and it should be compiled if we may need artifacts.

Implementations

impl<S> CacheEntry<S>

pub fn last_modified(&self) -> Duration

Returns the last modified timestamp Duration

pub fn find_artifact_path(&self, contract_name: &str) -> Option<&Path>

Returns the artifact path for the contract name.

Examples

use foundry_compilers::cache::CacheEntry;

let entry: CacheEntry = ...;
entry.find_artifact_path("Greeter");

pub fn read_last_modification_date(file: &Path) -> Result<u64>

Reads the last modification date from the file’s metadata

pub fn contains_version(&self, version: &Version) -> bool

Returns true if the artifacts set contains the given version

pub fn artifacts_versions( &self, ) -> impl Iterator<Item = (&Version, &CachedArtifact)>

Iterator that yields all artifact files and their version

pub fn find_artifact( &self, contract: &str, version: &Version, ) -> Option<&CachedArtifact>

Returns the artifact file for the contract and version pair

pub fn artifacts_for_version<'a>( &'a self, version: &'a Version, ) -> impl Iterator<Item = &'a CachedArtifact> + 'a

Iterator that yields all artifact files and their version

pub fn artifacts(&self) -> impl Iterator<Item = &CachedArtifact>

Iterator that yields all artifact files

pub fn artifacts_mut(&mut self) -> impl Iterator<Item = &mut CachedArtifact>

Mutable iterator over all artifact files

pub fn all_artifacts_exist(&self) -> bool

Checks if all artifact files exist

pub fn join_artifacts_files(&mut self, base: &Path)

Sets the artifact’s paths to base adjoined to the artifact’s path.

pub fn strip_artifact_files_prefixes(&mut self, base: &Path)

Removes base from the artifact’s path

Trait Implementations

impl<S: Clone> Clone for CacheEntry<S>

fn clone(&self) -> CacheEntry<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for CacheEntry<S>

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for CacheEntry<S>

where S: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: PartialEq> PartialEq for CacheEntry<S>

fn eq(&self, other: &CacheEntry<S>) -> bool

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

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<S> Serialize for CacheEntry<S>

where S: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: Eq> Eq for CacheEntry<S>

impl<S> StructuralPartialEq for CacheEntry<S>