Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Avoid using gen for rust 2024 preserved keyword #5923

Merged
merged 2 commits into from
Feb 24, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions clap_complete/examples/completion-derive.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,13 @@ struct ValueHintOpt {
email: Option<String>,
}

fn print_completions<G: Generator>(gen: G, cmd: &mut Command) {
generate(gen, cmd, cmd.get_name().to_string(), &mut io::stdout());
fn print_completions<G: Generator>(generator: G, cmd: &mut Command) {
generate(
generator,
cmd,
cmd.get_name().to_string(),
&mut io::stdout(),
);
}

fn main() {
Expand Down
9 changes: 7 additions & 2 deletions clap_complete/examples/completion.rs
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,13 @@ fn build_cli() -> Command {
.subcommand(value_hint_command)
}

fn print_completions<G: Generator>(gen: G, cmd: &mut Command) {
generate(gen, cmd, cmd.get_name().to_string(), &mut io::stdout());
fn print_completions<G: Generator>(generator: G, cmd: &mut Command) {
generate(
generator,
cmd,
cmd.get_name().to_string(),
&mut io::stdout(),
);
}

fn main() {
Expand Down
9 changes: 7 additions & 2 deletions clap_complete/examples/exhaustive.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,13 @@ fn main() {
println!("{matches:?}");
}

fn print_completions<G: Generator>(gen: G, cmd: &mut clap::Command) {
generate(gen, cmd, cmd.get_name().to_string(), &mut std::io::stdout());
fn print_completions<G: Generator>(generator: G, cmd: &mut clap::Command) {
generate(
generator,
cmd,
cmd.get_name().to_string(),
&mut std::io::stdout(),
);
}

const EMPTY: [&str; 0] = [];
Expand Down
10 changes: 5 additions & 5 deletions clap_complete/src/aot/generator/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ pub trait Generator {
/// }
/// ```
pub fn generate_to<G, S, T>(
gen: G,
generator: G,
cmd: &mut Command,
bin_name: S,
out_dir: T,
Expand All @@ -210,12 +210,12 @@ where
cmd.set_bin_name(bin_name);

let out_dir = PathBuf::from(out_dir.into());
let file_name = gen.file_name(cmd.get_bin_name().unwrap());
let file_name = generator.file_name(cmd.get_bin_name().unwrap());

let path = out_dir.join(file_name);
let mut file = File::create(&path)?;

_generate::<G>(gen, cmd, &mut file);
_generate::<G>(generator, cmd, &mut file);
Ok(path)
}

Expand Down Expand Up @@ -254,13 +254,13 @@ where
/// ```console
/// $ myapp generate-bash-completions > /usr/share/bash-completion/completions/myapp.bash
/// ```
pub fn generate<G, S>(gen: G, cmd: &mut Command, bin_name: S, buf: &mut dyn Write)
pub fn generate<G, S>(generator: G, cmd: &mut Command, bin_name: S, buf: &mut dyn Write)
where
G: Generator,
S: Into<String>,
{
cmd.set_bin_name(bin_name);
_generate::<G>(gen, cmd, buf);
_generate::<G>(generator, cmd, buf);
}

fn _generate<G: Generator>(gen: G, cmd: &mut Command, buf: &mut dyn Write) {
Expand Down
4 changes: 2 additions & 2 deletions clap_complete/src/aot/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@
//! )
//! }
//!
//! fn print_completions<G: Generator>(gen: G, cmd: &mut Command) {
//! generate(gen, cmd, cmd.get_name().to_string(), &mut io::stdout());
//! fn print_completions<G: Generator>(generator: G, cmd: &mut Command) {
//! generate(generator, cmd, cmd.get_name().to_string(), &mut io::stdout());
//! }
//!
//! fn main() {
Expand Down
4 changes: 2 additions & 2 deletions clap_complete/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
//! .value_parser(value_parser!(Shell)))
//! }
//!
//! fn print_completions<G: Generator>(gen: G, cmd: &mut Command) {
//! generate(gen, cmd, cmd.get_name().to_string(), &mut io::stdout());
//! fn print_completions<G: Generator>(generator: G, cmd: &mut Command) {
//! generate(generator, cmd, cmd.get_name().to_string(), &mut io::stdout());
//! }
//!
//! fn main() {
Expand Down
4 changes: 2 additions & 2 deletions clap_complete/tests/testsuite/common.rs
Original file line number Diff line number Diff line change
Expand Up @@ -286,12 +286,12 @@ pub(crate) fn subcommand_last(name: &'static str) -> clap::Command {

pub(crate) fn assert_matches(
expected: impl IntoData,
gen: impl clap_complete::Generator,
generator: impl clap_complete::Generator,
mut cmd: clap::Command,
name: &'static str,
) {
let mut buf = vec![];
clap_complete::generate(gen, &mut cmd, name, &mut buf);
clap_complete::generate(generator, &mut cmd, name, &mut buf);

snapbox::Assert::new()
.action_env(snapbox::assert::DEFAULT_ACTION_ENV)
Expand Down
4 changes: 2 additions & 2 deletions clap_complete_nushell/tests/common.rs
Original file line number Diff line number Diff line change
Expand Up @@ -246,12 +246,12 @@ pub(crate) fn value_hint_command(name: &'static str) -> Command {

pub(crate) fn assert_matches(
expected: impl IntoData,
gen: impl clap_complete::Generator,
generator: impl clap_complete::Generator,
mut cmd: Command,
name: &'static str,
) {
let mut buf = vec![];
clap_complete::generate(gen, &mut cmd, name, &mut buf);
clap_complete::generate(generator, &mut cmd, name, &mut buf);

snapbox::Assert::new()
.action_env(snapbox::assert::DEFAULT_ACTION_ENV)
Expand Down