Struct GenerateOptions

pub struct GenerateOptions {

    pub cargo: Option<PathBuf>,
    pub rustc: Option<PathBuf>,
    pub config: PathBuf,
    pub splicing_manifest: PathBuf,
    pub lockfile: Option<PathBuf>,
    pub cargo_lockfile: PathBuf,
    pub repository_dir: PathBuf,
    pub cargo_config: Option<PathBuf>,
    pub repin: bool,
    pub metadata: Option<PathBuf>,
    pub dry_run: bool,
    pub nonhermetic_root_bazel_workspace_dir: Utf8PathBuf,
    pub paths_to_track: PathBuf,
    pub warnings_output_path: PathBuf,
    /* private fields */
}

Command line options for the generate subcommand

Fields

cargo: Option<PathBuf>

The path to a Cargo binary to use for gathering metadata

rustc: Option<PathBuf>

The path to a rustc binary for use with Cargo

config: PathBuf

The config file with information about the Bazel and Cargo workspace

splicing_manifest: PathBuf

A generated manifest of splicing inputs

lockfile: Option<PathBuf>

The path to either a Cargo or Bazel lockfile

cargo_lockfile: PathBuf

The path to a Cargo.lock file.

repository_dir: PathBuf

The directory of the current repository rule

cargo_config: Option<PathBuf>

A Cargo config file to use when gathering metadata

repin: bool

Whether or not to ignore the provided lockfile and re-generate one

metadata: Option<PathBuf>

The path to a Cargo metadata json file. This file must be next to a Cargo.toml and Cargo.lock file.

dry_run: bool

If true, outputs will be printed instead of written to disk.

nonhermetic_root_bazel_workspace_dir: Utf8PathBuf

The path to the Bazel root workspace (i.e. the directory containing the WORKSPACE.bazel file or similar). BE CAREFUL with this value. We never want to include it in a lockfile hash (to keep lockfiles portable), which means you also should not use it anywhere that should be guarded by a lockfile hash. You basically never want to use this value.

paths_to_track: PathBuf

Path to write a list of files which the repository_rule should watch. If any of these paths change, the repository rule should be rerun. These files may be outside of the Bazel-managed workspace. A (possibly empty) JSON sorted array of strings will be unconditionally written to this file.

warnings_output_path: PathBuf

Path to write a list of warnings which the repository rule should emit. A (possibly empty) JSON array of strings will be unconditionally written to this file. Each warning should be printed. This mechanism exists because this process’s output is often hidden by default, so this provides a way for the repository rule to force printing.

Trait Implementations

impl Args for GenerateOptions

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

impl CommandFactory for GenerateOptions

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 GenerateOptions

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

Formats the value using the given formatter.

impl FromArgMatches for GenerateOptions

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 GenerateOptions

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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.