Struct foundry_compilers_artifacts::Remapping

pub struct Remapping {
    pub context: Option<String>,
    pub name: String,
    pub path: String,
}

The solidity compiler can only reference files that exist locally on your computer. So importing directly from GitHub (as an example) is not possible.

Let’s imagine you want to use OpenZeppelin’s amazing library of smart contracts, @openzeppelin/contracts-ethereum-package:

pragma solidity 0.5.11;

import "@openzeppelin/contracts-ethereum-package/contracts/math/SafeMath.sol";

contract MyContract {
    using SafeMath for uint256;
    ...
}

When using solc, you have to specify the following:

• A prefix: the path that’s used in your smart contract, i.e. @openzeppelin/contracts-ethereum-package
• A target: the absolute path of the downloaded contracts on your computer

The format looks like this: solc prefix=target ./MyContract.sol

For example:

solc --bin \
    @openzeppelin/contracts-ethereum-package=/Your/Absolute/Path/To/@openzeppelin/contracts-ethereum-package \
    ./MyContract.sol

You can also specify a context which limits the scope of the remapping to a subset of your project. This allows you to apply the remapping only to imports located in a specific library or a specific file. Without a context a remapping is applied to every matching import in all files.

The format is: solc context:prefix=target ./MyContract.sol

Source

Fields

context: Option<String>

name: String

path: String

Implementations

impl Remapping

pub fn into_relative(self, root: &Path) -> RelativeRemapping

Convenience function for RelativeRemapping::new

pub fn strip_prefix(&mut self, base: &Path) -> &mut Remapping

Removes the base path from the remapping

impl Remapping

pub fn find_many_str(path: &Path) -> Vec<String>

Attempts to autodetect all remappings given a certain root path.

See Self::find_many for more information.

pub fn find_many(dir: &Path) -> Vec<Remapping>

Attempts to autodetect all remappings given a certain root path.

This will recursively scan all subdirectories of the root path, if a subdirectory contains a solidity file then this a candidate for a remapping. The name of the remapping will be the folder name.

However, there are additional rules/assumptions when it comes to determining if a candidate should in fact be a remapping:

All names and paths end with a trailing “/”

The name of the remapping will be the parent folder of a solidity file, unless the folder is named src, lib or contracts in which case the name of the remapping will be the parent folder’s name of src, lib, contracts: The remapping of repo1/src/contract.sol is name: "repo1/", path: "repo1/src/"

Nested remappings need to be separated by src, lib or contracts, The remapping of repo1/lib/ds-math/src/contract.sol is name: "ds-math/", "repo1/lib/ds-math/src/"

Remapping detection is primarily designed for dapptool’s rules for lib folders, however, we attempt to detect and optimize various folder structures commonly used in node_modules dependencies. For those the same rules apply. In addition, we try to unify all remappings discovered according to the rules mentioned above, so that layouts like,

which would be multiple rededications according to our rules (“governance”, “protocol-v2”), are unified into @aave by looking at their common ancestor, the root of this subdirectory (@aave)

pub fn slash_path(&mut self)

Converts any \\ separators in the path to /

Trait Implementations

impl Clone for Remapping

fn clone(&self) -> Remapping

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Remapping

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Remapping

fn deserialize<D>( deserializer: D, ) -> Result<Remapping, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Remapping

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

Formats the value using the given formatter.

impl From<RelativeRemapping> for Remapping

fn from(r: RelativeRemapping) -> Remapping

Converts to this type from the input type.

impl From<Remapping> for RelativeRemapping

fn from(r: Remapping) -> RelativeRemapping

Converts to this type from the input type.

impl FromStr for Remapping

type Err = RemappingError

The associated error which can be returned from parsing.

fn from_str(remapping: &str) -> Result<Remapping, <Remapping as FromStr>::Err>

Parses a string s to return a value of this type.

impl Ord for Remapping

fn cmp(&self, other: &Remapping) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Remapping

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

fn partial_cmp(&self, other: &Remapping) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Remapping

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Remapping

impl StructuralPartialEq for Remapping