Add #[track_caller] to all functions that are marked with ***Panics*** and can potentially panic
#389
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
…s***` and can potentially panic
…tion in case of panic
cuviper
reviewed
Apr 30, 2025
src/map.rs
Outdated
| @@ -1388,6 +1388,7 @@ where | |||
| /// Returns a reference to the value corresponding to the supplied `key`. | |||
| /// | |||
| /// ***Panics*** if `key` is not present in the map. | |||
| #[track_caller] | |||
There was a problem hiding this comment.
Last time, we decided this wasn't needed because the trait already has it:
#367 (comment)
There was a problem hiding this comment.
Oh, I didn't know that the trait already has it, thank you for the clarification
src/map/core.rs
Outdated
Comment on lines
83
to
84
| #[track_caller] | ||
| fn insert_bulk_no_grow<K, V>(indices: &mut Indices, entries: &[Bucket<K, V>]) { |
There was a problem hiding this comment.
This is an internal function, and the pre-condition is entirely in our own control. If this ever fails, I think it would be confusing to the user to have their caller location reported, when they really should report a bug to us. So, I don't think we should add this one.
There was a problem hiding this comment.
Yeah, you're right, I just slapped #[track_caller] all over the place without even checking whether the function was internal or not
cuviper
requested changes
May 13, 2025
… as well as from internal functions
|
Ok, here you go |
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.
No description provided.