Deprecate Error::description #419
Conversation
|
@apoelstra I don't think it will ever get removed, as per Rust's standard library backward compatibility guarantees. AFAIU, even editions can't break stdlib backward compat. |
Nit: Did you mean std::error::Error::description? |
|
Yeah, it will probably only be removed on Rust 2.X. Pretty sure they only ever removed a function from stdlib when it had a clear vulnerability and practically no-one has used it. You can still do |
src/network/mod.rs
Outdated
| @@ -47,7 +47,8 @@ impl fmt::Display for Error { | |||
| fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |||
| match *self { | |||
| Error::Io(ref e) => fmt::Display::fmt(e, f), | |||
| Error::SocketMutexPoisoned | Error::SocketNotConnectedToPeer => f.write_str(error::Error::description(self)), | |||
| Error::SocketMutexPoisoned => f.write_str("socket mutex was poisoned"), | |||
| Error::SocketNotConnectedToPeer => f.write_str("socket mutex was poisoned"), | |||
There was a problem hiding this comment.
this message doesn't seem right
There was a problem hiding this comment.
You're right!
Thanks for catching this, I re-reviewed my PR to make sure I didn't miss anything else
173d726 to
654232a
Compare
Codecov Report
@@ Coverage Diff @@
## master #419 +/- ##
==========================================
+ Coverage 85.74% 87.19% +1.45%
==========================================
Files 40 40
Lines 7483 8627 +1144
==========================================
+ Hits 6416 7522 +1106
- Misses 1067 1105 +38
Continue to review full report at Codecov.
|
|
@elichai FYI it's UB only if you take reference to a field, which requires |
You sure about that? |
|
Ah, good point, so it's not yet, but at least one gets a warning. |
Now that 1.42.0 is out
std::error::Error::descriptionis officially deprecated.sadly we can't stop using it because of our MSRV, but at least we lay the ground and encourage our users to stop using it too.