Struct foundry_compilers::project_util::mock::MockProjectGenerator

pub struct MockProjectGenerator { /* private fields */ }

Available on crate feature project-util only.

Represents a virtual project

Implementations

impl MockProjectGenerator

pub fn new(settings: &MockProjectSettings) -> Self

Create a new project and populate it using the given settings

pub fn create<D: ParsedSource>(paths: &ProjectPathsConfig) -> Result<Self>

Create a skeleton of a real project

pub fn into_inner(self) -> MockProjectSkeleton

Consumes the type and returns the underlying skeleton

pub fn write_to<L: Language>( &self, paths: &ProjectPathsConfig<L>, version: impl AsRef<str>, ) -> Result<()>

Generate all solidity files and write under the paths config

pub fn remappings_at(&self, root: &Path) -> Vec<Remapping>

Returns all the remappings for the project for the given root path

pub fn remappings(&self) -> Vec<Remapping>

Returns all the remappings for the project

pub fn random() -> Self

Generates a random project with random settings

pub fn populate(&mut self, settings: &MockProjectSettings) -> &mut Self

Adds sources and libraries and populates imports based on the settings

pub fn add_source(&mut self) -> &mut Self

Adds a new source file

pub fn add_sources(&mut self, num: usize) -> &mut Self

Adds num new source files

pub fn add_lib_file(&mut self, lib_id: usize) -> &mut Self

Adds a new lib file

pub fn add_lib_files(&mut self, num: usize, lib_id: usize) -> &mut Self

Adds num new source files

pub fn add_lib(&mut self, num_files: usize) -> &mut Self

Adds a new lib with the number of lib files

pub fn assign_empty_files(&mut self) -> &mut Self

randomly assign empty file status so that mocked files don’t emit artifacts

pub fn populate_imports(&mut self, settings: &MockProjectSettings) -> &mut Self

Populates the imports of the project

pub fn get_file(&self, id: usize) -> &MockFile

Returns the file for the given id

pub fn file_ids(&self) -> impl Iterator<Item = usize> + '_

All file ids

pub fn used_file_ids(&self) -> impl Iterator<Item = usize> + '_

Returns an iterator over all file ids that are source files or imported by source files

In other words, all files that are relevant in order to compile the project’s source files.

pub fn internal_file_ids(&self) -> impl Iterator<Item = usize> + '_

All ids of internal files

pub fn external_file_ids(&self) -> impl Iterator<Item = usize> + '_

All ids of external files

pub fn modify_file( &self, id: usize, paths: &ProjectPathsConfig, version: impl AsRef<str>, ) -> Result<PathBuf>

Modifies the content of the given file

Trait Implementations

impl Default for MockProjectGenerator

fn default() -> Self

Returns the “default value” for a type.

impl From<MockProjectSkeleton> for MockProjectGenerator

fn from(inner: MockProjectSkeleton) -> Self

Converts to this type from the input type.

impl Serialize for MockProjectGenerator

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

where __S: Serializer,

Serialize this value into the given Serde serializer.