Struct BuildArgs

pub struct BuildArgs {
    pub paths: Option<Vec<PathBuf>>,
    pub names: bool,
    pub sizes: bool,
    pub ignore_eip_3860: bool,
    pub build: BuildOpts,
    pub watch: WatchArgs,
}

CLI arguments for forge build.

CLI arguments take the highest precedence in the Config/Figment hierarchy. In order to override them in the foundry Config they need to be merged into an existing figment::Provider, like foundry_config::Config is.

BuildArgs implements figment::Provider in which all config related fields are serialized and then merged into an existing Config, effectively overwriting them.

Some arguments are marked as #[serde(skip)] and require manual processing in figment::Provider implementation

Fields

paths: Option<Vec<PathBuf>>

Build source files from specified paths.

names: bool

Print compiled contract names.

sizes: bool

Print compiled contract sizes. Constructor argument length is not included in the calculation of initcode size.

ignore_eip_3860: bool

Ignore initcode contract bytecode size limit introduced by EIP-3860.

build: BuildOpts

watch: WatchArgs

Implementations

impl BuildArgs

pub fn run(self) -> Result<ProjectCompileOutput>

pub fn project(&self) -> Result<Project>

Returns the Project for the current workspace

This loads the foundry_config::Config for the current workspace (see [foundry_config::utils::find_project_root] and merges the cli BuildArgs into it before returning [foundry_config::Config::project()]

pub fn is_watch(&self) -> bool

Returns whether BuildArgs was configured with --watch

pub(crate) fn watchexec_config(&self) -> Result<Config>

Returns the [watchexec::Config] necessary to bootstrap a new watch loop.

Trait Implementations

impl Args for BuildArgs

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 BuildArgs

fn clone(&self) -> BuildArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for BuildArgs

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 BuildArgs

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

Formats the value using the given formatter.

impl Default for BuildArgs

fn default() -> BuildArgs

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl FromArgMatches for BuildArgs

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 BuildArgs

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 BuildArgs

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 BuildArgs

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: 496 bytes