Struct foundry_compilers::sources::VersionedSourceFiles

pub struct VersionedSourceFiles(pub BTreeMap<PathBuf, Vec<VersionedSourceFile>>);

(source_file path -> SourceFile + solc version)

Tuple Fields

0: BTreeMap<PathBuf, Vec<VersionedSourceFile>>

Implementations

impl VersionedSourceFiles

pub fn slash_paths(&mut self)

Converts all \\ separators in all paths to /

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn files(&self) -> impl Iterator<Item = &PathBuf>

Returns an iterator over all files

pub fn into_ids(self) -> impl Iterator<Item = (u32, PathBuf)>

Returns an iterator over the source files’ IDs and path.

pub fn into_paths(self) -> impl Iterator<Item = (PathBuf, u32)>

Returns an iterator over the source files’ paths and IDs.

pub fn into_ids_with_version( self, ) -> impl Iterator<Item = (u32, PathBuf, Version)>

Returns an iterator over the source files’ IDs and path.

pub fn find_file(&self, source_file: impl AsRef<Path>) -> Option<&SourceFile>

Finds the first source file with the given path.

Examples

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

let project = Project::builder().build()?;
let output = project.compile()?.into_output();
let source_file = output.sources.find_file("src/Greeter.sol").unwrap();

pub fn find_file_and_version( &self, path: &Path, version: &Version, ) -> Option<&SourceFile>

Same as Self::find_file but also checks for version

pub fn find_id(&self, id: u32) -> Option<&SourceFile>

Finds the first source file with the given id

Examples

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

let project = Project::builder().build()?;
let output = project.compile()?.into_output();
let source_file = output.sources.find_id(0).unwrap();

pub fn find_id_and_version( &self, id: u32, version: &Version, ) -> Option<&SourceFile>

Same as Self::find_id but also checks for version

pub fn remove_by_path( &mut self, source_file: impl AsRef<Path>, ) -> Option<SourceFile>

Removes the first source_file with the given path from the set

Examples

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

let project = Project::builder().build()?;
let (mut sources, _) = project.compile()?.into_output().split();
let source_file = sources.remove_by_path("src/Greeter.sol").unwrap();

pub fn remove_by_id(&mut self, id: u32) -> Option<SourceFile>

Removes the first source_file with the given id from the set

Examples

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

let project = Project::builder().build()?;
let (mut sources, _) = project.compile()?.into_output().split();
let source_file = sources.remove_by_id(0).unwrap();

pub fn sources(&self) -> impl Iterator<Item = (&PathBuf, &SourceFile)>

Returns an iterator over all contracts and their names.

pub fn sources_with_version( &self, ) -> impl Iterator<Item = (&PathBuf, &SourceFile, &Version)>

Returns an iterator over (file, SourceFile, Version)

pub fn into_sources(self) -> impl Iterator<Item = (PathBuf, SourceFile)>

Returns an iterator over all contracts and their source names.

pub fn into_sources_with_version( self, ) -> impl Iterator<Item = (PathBuf, SourceFile, Version)>

Returns an iterator over all contracts and their source names.

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

Sets the sources’ file paths to root adjoined to self.file.

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

Removes base from all source file paths

Trait Implementations

impl AsMut<BTreeMap<PathBuf, Vec<VersionedSourceFile>>> for VersionedSourceFiles

fn as_mut(&mut self) -> &mut BTreeMap<PathBuf, Vec<VersionedSourceFile>>

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<BTreeMap<PathBuf, Vec<VersionedSourceFile>>> for VersionedSourceFiles

fn as_ref(&self) -> &BTreeMap<PathBuf, Vec<VersionedSourceFile>>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for VersionedSourceFiles

fn clone(&self) -> VersionedSourceFiles

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VersionedSourceFiles

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

Formats the value using the given formatter.

impl Default for VersionedSourceFiles

fn default() -> VersionedSourceFiles

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VersionedSourceFiles

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoIterator for VersionedSourceFiles

type Item = (PathBuf, Vec<VersionedSourceFile>)

The type of the elements being iterated over.

type IntoIter = IntoIter<PathBuf, Vec<VersionedSourceFile>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for VersionedSourceFiles

fn eq(&self, other: &VersionedSourceFiles) -> 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 Serialize for VersionedSourceFiles

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 VersionedSourceFiles

impl StructuralPartialEq for VersionedSourceFiles