Struct ProjectPathOpts

pub struct ProjectPathOpts {
    pub root: Option<PathBuf>,
    pub contracts: Option<PathBuf>,
    pub remappings: Vec<Remapping>,
    pub remappings_env: Option<String>,
    pub cache_path: Option<PathBuf>,
    pub lib_paths: Vec<PathBuf>,
    pub hardhat: bool,
    pub config_path: Option<PathBuf>,
}

Common arguments for a project’s paths.

Fields

root: Option<PathBuf>

The project’s root path.

By default root of the Git repository, if in one, or the current working directory.

contracts: Option<PathBuf>

The contracts source directory.

remappings: Vec<Remapping>

The project’s remappings.

remappings_env: Option<String>

The project’s remappings from the environment.

cache_path: Option<PathBuf>

The path to the compiler cache.

lib_paths: Vec<PathBuf>

The path to the library folder.

hardhat: bool

Use the Hardhat-style project layout.

This is the same as using: --contracts contracts --lib-paths node_modules.

config_path: Option<PathBuf>

Path to the config file.

Implementations

impl ProjectPathOpts

pub fn project_root(&self) -> PathBuf

Returns the root directory to use for configuring the project.

This will be the --root argument if provided, otherwise see [find_project_root].

Panics

Panics if the project root directory cannot be found. See [find_project_root].

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

Returns the remappings to add to the config

Trait Implementations

impl Args for ProjectPathOpts

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for ProjectPathOpts

fn clone(&self) -> ProjectPathOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for ProjectPathOpts

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for ProjectPathOpts

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

Formats the value using the given formatter.

impl Default for ProjectPathOpts

fn default() -> ProjectPathOpts

Returns the “default value” for a type.

impl<'a> From<&'a ProjectPathOpts> for Figment

fn from(args: &'a ProjectPathOpts) -> Self

Converts to this type from the input type.

impl FromArgMatches for ProjectPathOpts

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for ProjectPathOpts

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Provider for ProjectPathOpts

fn metadata(&self) -> Metadata

Returns the [Metadata] for this provider, identifying itself and its configuration sources.

fn data(&self) -> Result<Map<Profile, Dict>, Error>

Returns the configuration data.

fn profile(&self) -> Option<Profile>

Optionally returns a profile to set on the Figment this provider is merged into. The profile is only set if self is merged.

impl Serialize for ProjectPathOpts

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 176 bytes