Do not force &Option<T> in public API; use Option<&T> instead
#617
Conversation
This file contains hidden or 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
Narsil
approved these changes
Jun 15, 2025
Contributor
Narsil
left a comment
Narsil
left a comment
There was a problem hiding this comment.
LGTM, thanks for splitting this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What does this PR do?
Some public functions had
&Option<T>as one of their arguments. This is undesirable, because it forces the caller to have a literalOption<T>to which a reference is then taken.If the caller only has a
Tthat it does not wish to consume, this forces a clone. Taking anOption<&T>is more flexible, as&Option<T>can be converted toOption<&T>using theOption::as_ref()inherent method, and if one already has a bareT, then it's easy to create anOption<&T>by taking its address and wrapping it intoSome.The call site is also slightly simplified, as one no longer needs to write
&None.