Improve panic messages and add #[track_caller] attribute to functions that may panic
#367
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
cuviper
approved these changes
Jan 20, 2025
| @@ -1325,7 +1346,7 @@ where | |||
| /// | |||
| /// ***Panics*** if `key` is not present in the map. | |||
| fn index(&self, key: &Q) -> &V { | |||
There was a problem hiding this comment.
Just clarifying for future reference -- our Index and IndexMut implementations don't need #[track_caller] because the trait definition already applies it.
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.
Currently,
indexmappanic messages aren't really helpful, and this PR adds#[track_caller]attributes to functions that may panic, for better understanding where to actually look for the panic, and uses the same panic messages that standard collections do with more details.Seems like
#[track_caller]is compatible with no_std, and it shouldn't break anything.