| //! Used to simulate a fairly large number of subcommands |
| //! |
| //! CLI used is from rustup 408ed84f0e50511ed44a405dd91365e5da588790 |
| |
| #![allow(elided_lifetimes_in_paths)] // needed for divan |
| |
| use clap::{Arg, ArgAction, ArgGroup, ArgMatches, Command}; |
| |
| #[divan::bench] |
| fn build() -> Command { |
| build_cli() |
| } |
| |
| mod startup { |
| use super::{build_cli, ArgMatches}; |
| |
| #[divan::bench] |
| fn empty() -> ArgMatches { |
| build_cli().get_matches_from([""]) |
| } |
| |
| #[divan::bench] |
| fn sc() -> ArgMatches { |
| build_cli().get_matches_from(["rustup override add stable"]) |
| } |
| } |
| |
| fn build_cli() -> Command { |
| Command::new("rustup") |
| .version("0.9.0") // Simulating |
| .about("The Rust toolchain installer") |
| .after_help(RUSTUP_HELP) |
| .arg( |
| Arg::new("verbose") |
| .help("Enable verbose output") |
| .short('v') |
| .long("verbose") |
| .action(ArgAction::SetTrue), |
| ) |
| .subcommand( |
| Command::new("show") |
| .about("Show the active and installed toolchains") |
| .after_help(SHOW_HELP), |
| ) |
| .subcommand( |
| Command::new("install") |
| .about("Update Rust toolchains") |
| .after_help(TOOLCHAIN_INSTALL_HELP) |
| .hide(true) // synonym for 'toolchain install' |
| .arg(Arg::new("toolchain").required(true)), |
| ) |
| .subcommand( |
| Command::new("update") |
| .about("Update Rust toolchains") |
| .after_help(UPDATE_HELP) |
| .arg(Arg::new("toolchain").required(true)) |
| .arg( |
| Arg::new("no-self-update") |
| .help("Don't perform self update when running the `rustup` command") |
| .long("no-self-update") |
| .action(ArgAction::SetTrue) |
| .hide(true), |
| ), |
| ) |
| .subcommand( |
| Command::new("default") |
| .about("Set the default toolchain") |
| .after_help(DEFAULT_HELP) |
| .arg(Arg::new("toolchain").required(true)), |
| ) |
| .subcommand( |
| Command::new("toolchain") |
| .about("Modify or query the installed toolchains") |
| .after_help(TOOLCHAIN_HELP) |
| .subcommand(Command::new("list").about("List installed toolchains")) |
| .subcommand( |
| Command::new("install") |
| .about("Install or update a given toolchain") |
| .arg(Arg::new("toolchain").required(true)), |
| ) |
| .subcommand( |
| Command::new("uninstall") |
| .about("Uninstall a toolchain") |
| .arg(Arg::new("toolchain").required(true)), |
| ) |
| .subcommand( |
| Command::new("link") |
| .about("Create a custom toolchain by symlinking to a directory") |
| .arg(Arg::new("toolchain").required(true)) |
| .arg(Arg::new("path").required(true)), |
| ) |
| .subcommand( |
| Command::new("update") |
| .hide(true) // synonym for 'install' |
| .arg(Arg::new("toolchain").required(true)), |
| ) |
| .subcommand( |
| Command::new("add") |
| .hide(true) // synonym for 'install' |
| .arg(Arg::new("toolchain").required(true)), |
| ) |
| .subcommand( |
| Command::new("remove") |
| .hide(true) // synonym for 'uninstall' |
| .arg(Arg::new("toolchain").required(true)), |
| ), |
| ) |
| .subcommand( |
| Command::new("target") |
| .about("Modify a toolchain's supported targets") |
| .subcommand( |
| Command::new("list") |
| .about("List installed and available targets") |
| .arg( |
| Arg::new("toolchain") |
| .long("toolchain") |
| .action(ArgAction::Set), |
| ), |
| ) |
| .subcommand( |
| Command::new("add") |
| .about("Add a target to a Rust toolchain") |
| .arg(Arg::new("target").required(true)) |
| .arg( |
| Arg::new("toolchain") |
| .long("toolchain") |
| .action(ArgAction::Set), |
| ), |
| ) |
| .subcommand( |
| Command::new("remove") |
| .about("Remove a target from a Rust toolchain") |
| .arg(Arg::new("target").required(true)) |
| .arg( |
| Arg::new("toolchain") |
| .long("toolchain") |
| .action(ArgAction::Set), |
| ), |
| ) |
| .subcommand( |
| Command::new("install") |
| .hide(true) // synonym for 'add' |
| .arg(Arg::new("target").required(true)) |
| .arg( |
| Arg::new("toolchain") |
| .long("toolchain") |
| .action(ArgAction::Set), |
| ), |
| ) |
| .subcommand( |
| Command::new("uninstall") |
| .hide(true) // synonym for 'remove' |
| .arg(Arg::new("target").required(true)) |
| .arg( |
| Arg::new("toolchain") |
| .long("toolchain") |
| .action(ArgAction::Set), |
| ), |
| ), |
| ) |
| .subcommand( |
| Command::new("component") |
| .about("Modify a toolchain's installed components") |
| .subcommand( |
| Command::new("list") |
| .about("List installed and available components") |
| .arg( |
| Arg::new("toolchain") |
| .long("toolchain") |
| .action(ArgAction::Set), |
| ), |
| ) |
| .subcommand( |
| Command::new("add") |
| .about("Add a component to a Rust toolchain") |
| .arg(Arg::new("component").required(true)) |
| .arg( |
| Arg::new("toolchain") |
| .long("toolchain") |
| .action(ArgAction::Set), |
| ) |
| .arg(Arg::new("target").long("target").action(ArgAction::Set)), |
| ) |
| .subcommand( |
| Command::new("remove") |
| .about("Remove a component from a Rust toolchain") |
| .arg(Arg::new("component").required(true)) |
| .arg( |
| Arg::new("toolchain") |
| .long("toolchain") |
| .action(ArgAction::Set), |
| ) |
| .arg(Arg::new("target").long("target").action(ArgAction::Set)), |
| ), |
| ) |
| .subcommand( |
| Command::new("override") |
| .about("Modify directory toolchain overrides") |
| .after_help(OVERRIDE_HELP) |
| .subcommand(Command::new("list").about("List directory toolchain overrides")) |
| .subcommand( |
| Command::new("set") |
| .about("Set the override toolchain for a directory") |
| .arg(Arg::new("toolchain").required(true)), |
| ) |
| .subcommand( |
| Command::new("unset") |
| .about("Remove the override toolchain for a directory") |
| .after_help(OVERRIDE_UNSET_HELP) |
| .arg( |
| Arg::new("path") |
| .long("path") |
| .action(ArgAction::Set) |
| .help("Path to the directory"), |
| ) |
| .arg( |
| Arg::new("nonexistent") |
| .long("nonexistent") |
| .action(ArgAction::SetTrue) |
| .help("Remove override toolchain for all nonexistent directories"), |
| ), |
| ) |
| .subcommand( |
| Command::new("add") |
| .hide(true) // synonym for 'set' |
| .arg(Arg::new("toolchain").required(true)), |
| ) |
| .subcommand( |
| Command::new("remove") |
| .hide(true) // synonym for 'unset' |
| .about("Remove the override toolchain for a directory") |
| .arg(Arg::new("path").long("path").action(ArgAction::Set)) |
| .arg( |
| Arg::new("nonexistent") |
| .long("nonexistent") |
| .action(ArgAction::SetTrue) |
| .help("Remove override toolchain for all nonexistent directories"), |
| ), |
| ), |
| ) |
| .subcommand( |
| Command::new("run") |
| .about("Run a command with an environment configured for a given toolchain") |
| .after_help(RUN_HELP) |
| .arg(Arg::new("toolchain").required(true)) |
| .arg( |
| Arg::new("command") |
| .required(true) |
| .num_args(1..) |
| .trailing_var_arg(true), |
| ), |
| ) |
| .subcommand( |
| Command::new("which") |
| .about("Display which binary will be run for a given command") |
| .arg(Arg::new("command").required(true)), |
| ) |
| .subcommand( |
| Command::new("doc") |
| .about("Open the documentation for the current toolchain") |
| .after_help(DOC_HELP) |
| .arg( |
| Arg::new("book") |
| .long("book") |
| .action(ArgAction::SetTrue) |
| .help("The Rust Programming Language book"), |
| ) |
| .arg( |
| Arg::new("std") |
| .long("std") |
| .action(ArgAction::SetTrue) |
| .help("Standard library API documentation"), |
| ) |
| .group(ArgGroup::new("page").args(["book", "std"])), |
| ) |
| .subcommand( |
| Command::new("man") |
| .about("View the man page for a given command") |
| .arg(Arg::new("command").required(true)) |
| .arg( |
| Arg::new("toolchain") |
| .long("toolchain") |
| .action(ArgAction::Set), |
| ), |
| ) |
| .subcommand( |
| Command::new("self") |
| .about("Modify the rustup installation") |
| .subcommand(Command::new("update").about("Download and install updates to rustup")) |
| .subcommand( |
| Command::new("uninstall") |
| .about("Uninstall rustup.") |
| .arg(Arg::new("no-prompt").short('y').action(ArgAction::SetTrue)), |
| ) |
| .subcommand( |
| Command::new("upgrade-data").about("Upgrade the internal data format."), |
| ), |
| ) |
| .subcommand( |
| Command::new("telemetry") |
| .about("rustup telemetry commands") |
| .hide(true) |
| .subcommand(Command::new("enable").about("Enable rustup telemetry")) |
| .subcommand(Command::new("disable").about("Disable rustup telemetry")) |
| .subcommand(Command::new("analyze").about("Analyze stored telemetry")), |
| ) |
| .subcommand( |
| Command::new("set") |
| .about("Alter rustup settings") |
| .subcommand( |
| Command::new("default-host") |
| .about("The triple used to identify toolchains when not specified") |
| .arg(Arg::new("host_triple").required(true)), |
| ), |
| ) |
| } |
| |
| static RUSTUP_HELP: &str = r" |
| rustup installs The Rust Programming Language from the official |
| release channels, enabling you to easily switch between stable, beta, |
| and nightly compilers and keep them updated. It makes cross-compiling |
| simpler with binary builds of the standard library for common platforms. |
| |
| If you are new to Rust consider running `rustup doc --book` |
| to learn Rust."; |
| |
| static SHOW_HELP: &str = r" |
| Shows the name of the active toolchain and the version of `rustc`. |
| |
| If the active toolchain has installed support for additional |
| compilation targets, then they are listed as well. |
| |
| If there are multiple toolchains installed then all installed |
| toolchains are listed as well."; |
| |
| static UPDATE_HELP: &str = r" |
| With no toolchain specified, the `update` command updates each of the |
| installed toolchains from the official release channels, then updates |
| rustup itself. |
| |
| If given a toolchain argument then `update` updates that toolchain, |
| the same as `rustup toolchain install`. |
| |
| 'toolchain' specifies a toolchain name, such as 'stable', 'nightly', |
| or '1.8.0'. For more information see `rustup help toolchain`."; |
| |
| static TOOLCHAIN_INSTALL_HELP: &str = r" |
| Installs a specific rust toolchain. |
| |
| The 'install' command is an alias for 'rustup update <toolchain>'. |
| |
| 'toolchain' specifies a toolchain name, such as 'stable', 'nightly', |
| or '1.8.0'. For more information see `rustup help toolchain`."; |
| |
| static DEFAULT_HELP: &str = r" |
| Sets the default toolchain to the one specified. If the toolchain is |
| not already installed then it is installed first."; |
| |
| static TOOLCHAIN_HELP: &str = r" |
| Many `rustup` commands deal with *toolchains*, a single installation |
| of the Rust compiler. `rustup` supports multiple types of |
| toolchains. The most basic track the official release channels: |
| 'stable', 'beta' and 'nightly'; but `rustup` can also install |
| toolchains from the official archives, for alternate host platforms, |
| and from local builds. |
| |
| Standard release channel toolchain names have the following form: |
| |
| <channel>[-<date>][-<host>] |
| |
| <channel> = stable|beta|nightly|<version> |
| <date> = YYYY-MM-DD |
| <host> = <target-triple> |
| |
| 'channel' is either a named release channel or an explicit version |
| number, such as '1.8.0'. Channel names can be optionally appended with |
| an archive date, as in 'nightly-2014-12-18', in which case the |
| toolchain is downloaded from the archive for that date. |
| |
| Finally, the host may be specified as a target triple. This is most |
| useful for installing a 32-bit compiler on a 64-bit platform, or for |
| installing the [MSVC-based toolchain] on Windows. For example: |
| |
| rustup toolchain install stable-x86_64-pc-windows-msvc |
| |
| For convenience, elements of the target triple that are omitted will be |
| inferred, so the above could be written: |
| |
| $ rustup default stable-msvc |
| |
| Toolchain names that don't name a channel instead can be used to name |
| custom toolchains with the `rustup toolchain link` command."; |
| |
| static OVERRIDE_HELP: &str = r" |
| Overrides configure rustup to use a specific toolchain when |
| running in a specific directory. |
| |
| Directories can be assigned their own Rust toolchain with |
| `rustup override`. When a directory has an override then |
| any time `rustc` or `cargo` is run inside that directory, |
| or one of its child directories, the override toolchain |
| will be invoked. |
| |
| To pin to a specific nightly: |
| |
| rustup override set nightly-2014-12-18 |
| |
| Or a specific stable release: |
| |
| rustup override set 1.0.0 |
| |
| To see the active toolchain use `rustup show`. To remove the override |
| and use the default toolchain again, `rustup override unset`."; |
| |
| static OVERRIDE_UNSET_HELP: &str = r" |
| If `--path` argument is present, removes the override toolchain for |
| the specified directory. If `--nonexistent` argument is present, removes |
| the override toolchain for all nonexistent directories. Otherwise, |
| removes the override toolchain for the current directory."; |
| |
| static RUN_HELP: &str = r" |
| Configures an environment to use the given toolchain and then runs |
| the specified program. The command may be any program, not just |
| rustc or cargo. This can be used for testing arbitrary toolchains |
| without setting an override. |
| |
| Commands explicitly proxied by `rustup` (such as `rustc` and `cargo`) |
| also have a shorthand for this available. The toolchain can be set by |
| using `+toolchain` as the first argument. These are equivalent: |
| |
| cargo +nightly build |
| |
| rustup run nightly cargo build"; |
| |
| static DOC_HELP: &str = r" |
| Opens the documentation for the currently active toolchain with the |
| default browser. |
| |
| By default, it opens the documentation index. Use the various flags to |
| open specific pieces of documentation."; |
| |
| fn main() { |
| divan::main(); |
| } |
