clap/clap_builder
Sean Allred 05cd057978
perf: Avoid retrieving possible_values unless used
In some sophisticated situations, these may be expensive to calculate.
One example might be a '--branch' option accepting any single Git
branch that exists on the remote -- in such a case, the remote would
need to be queried for all possible_values. The cost is ultimately
unavoidable at runtime since this validation has to happen eventually,
but there's no need to pay it when generating help text if
`is_hide_possible_values_set`.

To keep '-h' fast, avoid collecting `possible_values` during '-h'
unless we're actually going to use the values in display.

This optimization is repeated for the manpage renderer.

This is trivially based on the short-circuiting logic at [1], which at
least supports the idea that actually consuming the iterator is not
generally-guaranteed behavior when `hide_possible_values` is set.

Note on the 'expensive' mod: This keeps all the possible_values tests
in one file but allows the entire set of tests to be controlled by the
'strings' feature (which is required to be able to use String rather
than str for each possible value).

[1]: clap_builder/src/builder/command.rs:long_help_exists_
2023-12-28 10:06:35 -06:00
..
src perf: Avoid retrieving possible_values unless used 2023-12-28 10:06:35 -06:00
Cargo.toml chore: Release 2023-12-04 12:17:32 -06:00
CONTRIBUTING.md refactor: Split out clap_builder for faster derive builds 2023-03-24 21:50:02 -05:00
LICENSE-APACHE refactor: Split out clap_builder for faster derive builds 2023-03-24 21:50:02 -05:00
LICENSE-MIT refactor: Split out clap_builder for faster derive builds 2023-03-24 21:50:02 -05:00
README.md refactor: Split out clap_builder for faster derive builds 2023-03-24 21:50:02 -05:00

clap_builder

Builder implementation for clap.

docs.rs

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

See CONTRIBUTING for more details.