Struct ethers_solc::cache::SolFilesCache

pub struct SolFilesCache {
    pub format: String,
    pub files: BTreeMap<PathBuf, CacheEntry>,
}

A hardhat compatible cache representation

Fields

format: String

files: BTreeMap<PathBuf, CacheEntry>

Implementations

impl SolFilesCache

pub fn builder() -> SolFilesCacheBuilder

Example

Autodetect solc version and default settings

use ethers_solc::artifacts::Source;
use ethers_solc::cache::SolFilesCache;
let files = Source::read_all_from("./sources").unwrap();
let config = SolFilesCache::builder().insert_files(files, None).unwrap();

pub fn is_hardhat_format(&self) -> bool

Whether this cache’s format is the hardhat format identifier

pub fn is_ethers_format(&self) -> bool

Whether this cache’s format is our custom format identifier

pub fn read(path: impl AsRef<Path>) -> Result<Self>

Reads the cache json file from the given path

pub fn write(&self, path: impl AsRef<Path>) -> Result<()>

Write the cache to json file

pub fn remove_missing_files(&mut self)

pub fn remove_changed_files(&mut self, changed_files: &Sources)

pub fn get_changed_files<'a>(
    &'a self,
    sources: Sources,
    config: Option<&'a SolcConfig>
) -> Sources

Returns only the files that were changed from the provided sources, to save time when compiling.

pub fn has_changed(
    &self,
    file: impl AsRef<Path>,
    hash: impl AsRef<[u8]>,
    config: Option<&SolcConfig>
) -> bool

Returns true if the given content hash or config differs from the file’s or the file does not exist

pub fn get_changed_or_missing_artifacts_files<'a, T: ArtifactOutput>(
    &'a self,
    sources: Sources,
    config: Option<&'a SolcConfig>,
    artifacts_root: &Path
) -> Sources

Returns only the files that were changed or are missing artifacts compared to previous compiler execution, to save time when compiling.

pub fn has_changed_or_missing_artifact<T: ArtifactOutput>(
    &self,
    file: &Path,
    hash: &[u8],
    config: Option<&SolcConfig>,
    artifacts_root: &Path
) -> bool

Returns true if the given content hash or config differs from the file’s or the file does not exist or the files’ artifacts are missing

pub fn all_artifacts_exist<T: ArtifactOutput>(
    &self,
    artifacts_root: &Path
) -> bool

Checks if all artifact files exist

pub fn read_artifacts<T: ArtifactOutput>(
    &self,
    artifacts_root: &Path
) -> Result<BTreeMap<PathBuf, T::Artifact>>

Reads all cached artifacts from disk using the given ArtifactOutput handler

impl SolFilesCache

pub async fn async_read(path: impl AsRef<Path>) -> Result<Self>

pub async fn async_write(&self, path: impl AsRef<Path>) -> Result<()>

Trait Implementations

impl Clone for SolFilesCache

fn clone(&self) -> SolFilesCache

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SolFilesCache

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SolFilesCache

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<SolFilesCache> for SolFilesCache

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

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

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

This method tests for !=.

impl Serialize for SolFilesCache

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

Serialize this value into the given Serde serializer.

impl Eq for SolFilesCache

impl StructuralEq for SolFilesCache

impl StructuralPartialEq for SolFilesCache