Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-14 14:52:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
clap/v3_changes.md
Kevin K 60c634be51
api(App): adds App::mut_arg to be able to mutate Args after they've been added to an App 
Once can now mutate an Arg instance after it's already been added to an App struct.
This is helpful when you wish to add all the args in an non-verbose way, such as
via the usage strings, but wish for a handful to have settings which arne't posible
in the usage string definitions.
2018-03-21 19:26:22 -04:00

1.9 KiB
Raw Blame History

Highlights

  • Lazy propagation
  • Lazy requirement validation
  • App::write_help takes &mut self now
  • App::override_usage No longer implies \t which allows multi lined usages
  • In usage parser, for options [name]... --option [val] results in ArgSettings::MultipleOccurrences but --option [val]... results in ArgSettings::MultipleValues and ArgSettings::MultipleOccurrences. Before both resulted in the same thing
  • Allow empty values no longer default
  • UseValueDelimiter no longer the default
  • Multiple delima fixed (vals vs occurrences)
  • Ability to mutate args once they've been added to an App
  • App::args and App::arg are more generic

How to Upgrade

If you use Arg::multiple(true)

Deprecations

Simple Renames

App

  • App::get_matches_safe -> App::try_get_matches
  • App::get_matches_from_safe -> App::try_get_matches_from
  • App::get_matches_safe_borrow -> App::try_get_matches_from_mut
  • App::usage -> App::override_usage
  • App::help -> App::override_help
  • App::template -> App::help_template

Arg

  • Arg::unset -> Arg::unset_setting
  • Arg::set -> Arg::setting

Structural Changes

App

  • App::version_message -> App::mut_arg
  • App::version_short -> App::mut_arg
  • App::help_message -> App::mut_arg
  • App::help_short -> App::mut_arg
  • App::args_from_usage -> App::args(&str)
  • App::arg_from_usage -> App::arg(&str)
  • App::write_help -> &self -> &mut self (#808)
  • App::gen_completions -> clap_completions::generate
  • App::gen_completions_to -> clap_completions::generate_to
  • App::settings -> App::setting(Setting1 | Setting2)
  • App::unset_settings -> App::unset_setting(Setting1 | Setting2)
  • App::global_settings -> App::global_setting(Setting1 | Setting2)

Arg

  • Arg::from_usage -> Arg::from(&str)

Additional APIs

App

  • App::mut_arg

Arg