Support unsetting/removing the default if an option/flag is set #2296
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pksunkara
requested changes
Jan 17, 2021
src/build/arg/mod.rs
Outdated
| @@ -2497,7 +2497,8 @@ impl<'help> Arg<'help> { | |||
|
|
|||
| /// Specifies the value of the argument if `arg` has been used at runtime. If `val` is set to | |||
| /// `None`, `arg` only needs to be present. If `val` is set to `"some-val"` then `arg` must be | |||
| /// present at runtime **and** have the value `val`. | |||
| /// present at runtime **and** have the value `val`. Setting `default` to `None` removes any | |||
There was a problem hiding this comment.
Instead of adding it here, add a separate note describing the scenario and what happens after the first note below.
There was a problem hiding this comment.
I moved this line down to the later example.
pksunkara
requested changes
Jan 24, 2021
| /// .get_matches_from(vec![ | ||
| /// "prog", "--opt", "hahaha" | ||
| /// ]); | ||
| /// | ||
| /// assert_eq!(m.value_of("other"), None); | ||
| /// ``` | ||
| /// | ||
| /// We can also remove a default if the flag was set by setting `default` to `None`. |
There was a problem hiding this comment.
This needs better phrasing. It does not explain things properly as it is right now.
| self, | ||
| arg_id: T, | ||
| val: Option<&'help str>, | ||
| default: &'help str, | ||
| default: S, |
| mut self, | ||
| arg_id: T, | ||
| val: Option<&'help OsStr>, | ||
| default: &'help OsStr, | ||
| default: S, |
| @@ -2700,12 +2722,14 @@ impl<'help> Arg<'help> { | |||
| /// ``` | |||
| /// [`Arg::takes_value(true)`]: ./struct.Arg.html#method.takes_value | |||
| /// [`Arg::default_value_if`]: ./struct.Arg.html#method.default_value_if | |||
| pub fn default_value_ifs<T: Key>( | |||
| pub fn default_value_ifs<T: Key, S: Into<Option<&'help str>> + Copy>( | |||
There was a problem hiding this comment.
This function needs documentation addition.
|
Hey, why was this closed? |
Sorry I should have left a message. Was just going through notifications and closing things I'm no longer working on. Feel free to re-use any parts of this code. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For
Arg::default_vals_ifand friends, allow anOption<&str>as the default instead of&str. This allows you to unset the default if some other option/flag is set or has some specific value. To avoid breaking existing code, the modified API takesimpl Into<Option<&str>>instead of justOption<&str>.Example:
Closes #1406