Introduce write_err macro
#446
Merged
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
Kixunil
reviewed
Jun 10, 2022
src/key.rs
Outdated
| impl std::error::Error for InvalidParityValue {} | ||
| impl std::error::Error for InvalidParityValue { | ||
| fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { | ||
| None |
There was a problem hiding this comment.
Is the point of this to express "no, we didn't forget about this"?
There was a problem hiding this comment.
I'm going to remove this, I did not think thoroughly enough when doing this to realise I was just adding the default implementation :) Thanks
src/lib.rs
Outdated
| NotEnoughMemory => "secp: not enough memory allocated", | ||
| InvalidPublicKeySum => "secp: the sum of public keys was invalid or the input vector lengths was less than 1", | ||
| InvalidParityValue(_) => "couldn't create parity", | ||
| }) |
There was a problem hiding this comment.
I believe it was previously more readable, but we should use write_err!() anyway. I think it's OK to copy-paste the macro?
There was a problem hiding this comment.
Done, as suggested. Cheers.
The current display code for `Error` is a little unusual. We typically just implement `Display` and if a `str` is needed use `format!`. Improve the `Error` type by doing - Remove the `as_str` function and implement `Display` directly. - Remove the 'secp: ' prefix of all the error messages. - Use a newly defined macro `write_err` that writes the error if `std` feature is not enabled so that no-std builds do not loose error info. Note: The `write_err` macro is currently being introduced in `rust-bitcoin` also. Elect to just duplicate it here and not share it between the crates.
4fb4fa0 to
946cd83
Compare
apoelstra
approved these changes
Jun 15, 2022
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.
Introduce
write_errmacro and improve theDisplayimplementation onError.This PR is re-written after review below. The
std::error::Errorimplementation is removed in favour of #409. Now only includes theDisplaystuff.