rust: avoid using unwrap()#117
Merged
sourya-deepsource merged 1 commit intoDeepSourceCorp:masterfrom Mar 6, 2025
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
hrideshmg
force-pushed
the
rust_avoid_unwrap
branch
from
e24e286 to
ae5e51a
Compare
sourya-deepsource
approved these changes
Mar 6, 2025
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
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.
Description
This PR adds a new rust checker to detect the use of
.unwrap()in Rust code. While.unwrap()is convenient, it can lead to unexpected panics and is only meant for quick prototyping (see rust error handling). This checker is flagged as anantipatternsince it does not impact security much.Detection Logic
The checker flags the following cases:
.unwrap()on anOptionorResultRecommended Alternatives
Instead of using
.unwrap(), consider:matchorif let.unwrap_or_else()to provide a fallback value or handle errors gracefully.expect()with a meaningful message if a panic is intentionalExclusions
To reduce noise, the checker does not flag occurrences in test files, vendor dependencies, or test directories.