Struct foundry_compilers::remappings::RelativeRemappingPathBuf

pub struct RelativeRemappingPathBuf {
    pub parent: Option<PathBuf>,
    pub path: PathBuf,
}

The path part of the Remapping that knows the path of the file it was configured in, if any.

A Remapping is intended to be absolute, but paths in configuration files are often desired to be relative to the configuration file itself. For example, a path of weird-erc20/=lib/weird-erc20/src/ configured in a file /var/foundry.toml might be desired to resolve as a weird-erc20/=/var/lib/weird-erc20/src/ remapping.

Fields

parent: Option<PathBuf>

path: PathBuf

Implementations

impl RelativeRemappingPathBuf

pub fn with_root(parent: impl AsRef<Path>, path: impl AsRef<Path>) -> Self

Creates a new RelativeRemappingPathBuf that checks if the path is a child path of parent.

pub fn original(&self) -> &Path

Returns the path as it was declared, without modification.

pub fn relative(&self) -> PathBuf

Returns this path relative to the file it was delcared in, if any. Returns the original if this path was not declared in a file or if the path has a root.

Trait Implementations

impl Clone for RelativeRemappingPathBuf

fn clone(&self) -> RelativeRemappingPathBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelativeRemappingPathBuf

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

Formats the value using the given formatter.

impl<P: AsRef<Path>> From<P> for RelativeRemappingPathBuf

fn from(path: P) -> RelativeRemappingPathBuf

Converts to this type from the input type.

impl Ord for RelativeRemappingPathBuf

fn cmp(&self, other: &RelativeRemappingPathBuf) -> 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 RelativeRemappingPathBuf

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

fn partial_cmp(&self, other: &RelativeRemappingPathBuf) -> 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 Eq for RelativeRemappingPathBuf

impl StructuralPartialEq for RelativeRemappingPathBuf