Make ParsableCommand.run() a mutating method #163
Merged
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.
Description
This changes
ParsableCommand'srunrequirement to be mutating. This allows for things like in-place sorting or filtering of arguments without making a mutable copy.This change supersedes #33.
Detailed Design
The only change here is the switch to mutating for the
run()method.Documentation Plan
We didn't previously mention the non-mutatingness of
run(), so that doesn't require a change. All code samples have been updated to implement the new requirement.Test Plan
All existing tests pass with the change.
Source Impact
This will require code changes for every command that implements arun()method, since a non-mutatingrun()won't properly satisfy the new requirement. SinceParsableCommandprovides a default implementation forrun(), there unfortunately won't be any indication of this change at compile time.Apparently this is in fact source-compatible with existing code. Clients can add
mutatingas they want, but existing non-mutatingrun()methods will be called correctly. 🎉Checklist