Struct BindArgs

pub struct BindArgs {

    pub bindings: Option<PathBuf>,
    pub select: Vec<Regex>,
    pub select_all: bool,
    crate_name: String,
    crate_version: String,
    crate_description: String,
    crate_license: String,
    module: bool,
    overwrite: bool,
    single_file: bool,
    skip_cargo_toml: bool,
    skip_build: bool,
    skip_extra_derives: bool,
    alloy: bool,
    alloy_version: Option<String>,
    alloy_rev: Option<String>,
    ethers: bool,
    build: BuildOpts,
}

CLI arguments for forge bind.

Fields

bindings: Option<PathBuf>

Path to where the contract artifacts are stored.

select: Vec<Regex>

Create bindings only for contracts whose names match the specified filter(s)

select_all: bool

Explicitly generate bindings for all contracts

By default all contracts ending with Test or Script are excluded.

crate_name: String

The name of the Rust crate to generate.

This should be a valid crates.io crate name, however, this is not currently validated by this command.

crate_version: String

The version of the Rust crate to generate.

This should be a standard semver version string, however, this is not currently validated by this command.

crate_description: String

The description of the Rust crate to generate.

This will be added to the package.description field in Cargo.toml.

crate_license: String

The license of the Rust crate to generate.

This will be added to the package.license field in Cargo.toml.

module: bool

Generate the bindings as a module instead of a crate.

overwrite: bool

Overwrite existing generated bindings.

By default, the command will check that the bindings are correct, and then exit. If –overwrite is passed, it will instead delete and overwrite the bindings.

single_file: bool

Generate bindings as a single file.

skip_cargo_toml: bool

Skip Cargo.toml consistency checks.

skip_build: bool

Skips running forge build before generating binding

skip_extra_derives: bool

Don’t add any additional derives to generated bindings

alloy: bool

Generate bindings for the alloy library, instead of ethers.

alloy_version: Option<String>

Specify the alloy version on Crates.

alloy_rev: Option<String>

Specify the alloy revision on GitHub.

ethers: bool

Generate bindings for the ethers library (removed), instead of alloy.

build: BuildOpts

Implementations

impl BindArgs

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

fn get_filter(&self) -> Result<Filter>

fn get_json_files( &self, artifacts: &Path, ) -> Result<impl Iterator<Item = (String, PathBuf)>>

Returns an iterator over the JSON files and the contract name in the artifacts directory.

fn get_solmacrogen(&self, artifacts: &Path) -> Result<MultiSolMacroGen>

fn check_existing_bindings( &self, artifacts: &Path, bindings_root: &Path, ) -> Result<()>

Check that the existing bindings match the expected abigen output

fn generate_bindings( &self, artifacts: &Path, bindings_root: &Path, ) -> Result<()>

Generate the bindings

Trait Implementations

impl Args for BindArgs

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 BindArgs

fn clone(&self) -> BindArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for BindArgs

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 BindArgs

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl FromArgMatches for BindArgs

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 BindArgs

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.

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