this post was submitted on 16 Sep 2024
53 points (100.0% liked)
Rust
5953 readers
12 users here now
Welcome to the Rust community! This is a place to discuss about the Rust programming language.
Wormhole
Credits
- The icon is a modified version of the official rust logo (changing the colors to a gradient and black background)
founded 1 year ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
if you're really that bothered..
or use a wrapper struct, if you really really want the method to be called exactly
lock
.I think a better solution would be to add a method called something like ulock that does a combined lock and unwrap.
My concern with lock+unwrap is only partly because of convenience; I also didn't like it because I think it's a bad idea to get people used to casually calling unwrap, because it tends to hide inadequate error handing.
Now that I think about it, I don't like how unwrap can signal either "I know this can't fail", "the possible error states are too rare to care about" or "I can't be bothered with real error handing right now". In one or two of those cases you want to leave it in my production code, and in the last you want to audit all instances and replace them with proper error handing. Using the same function for all three cases makes that difficult.
That's exactly what's done above using an extension trait! You can
mutex_val.ulock()
with it!That's why you're told (clippy does that i think) to use
expect
instead, so you can signal "whatever string" you want to signal precisely.Exactly! My code has a handful of "expect()" calls in it, and each one self-documents why it's okay. It's like a comment, but it appears in logs if it ever triggers.
Best practice when using
.unwrap()
in production code is to put a line of documentation immediately above the use of.unwrap()
that describes the safety invariants which allow the unwrap to be safe.Since code churn could eventually cause those safety invariants to be violated, I think it's not a bad thing for a blunt audit of
.unwrap()
to bring your attention to those cases and prompt to reevaluate if the invariants are still satisfied.