Add IntoInnerError::into_error() #304
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
BurntSushi
requested changes
Mar 6, 2023
There was a problem hiding this comment.
Thanks! This LGTM with a couple nits.
it's forced to return the entire IntoInnerError, which is very big compared to io::Error which is where the actual error is.
Note that an IntoInnerError is just a std::io::Error and a W. So if it's big, it's because your W is big. :-)
src/error.rs
Outdated
| @@ -312,6 +312,13 @@ impl<W> IntoInnerError<W> { | |||
| &self.err | |||
| } | |||
|
|
|||
| /// Consumes the [`IntoInnerError`] and returns the error which caused the call to | |||
| /// [`Writer::into_inner()`] to fail. Unlike `error`, this can be used to | |||
| /// obtain ownership of the underlying error. | |||
There was a problem hiding this comment.
Please make sure the docs are wrapped to 79 columns, inclusive. (They don't currently appear to be.)
Also, please use Writer::into_inner and drop the parens.
And please use IntoInnerError::error instead of error.
There was a problem hiding this comment.
Docs wrapped, and I managed to link to Writer::into_iter() correctly this time.
Currently, for code that doesn't attempt to recover from errors but just reports the error to the caller, it's forced to return the entire `IntoInnerError`, which is very big compared to `io::Error` which is where the actual error is. This commit adds `IntoInnerError::into_error()` method that consumes `IntoInnerError` and returns contained `io::Error`. This mirrors the API of `std::io::IntoInnerError` in Rust stdlib, which provides such method. Signed-off-by: Marcel Guzik <[email protected]>
|
This PR is in |
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.
Currently, for code that doesn't attempt to recover from errors but just reports the error to the caller, it's forced to return the entire
IntoInnerError, which is very big compared toio::Errorwhich is where the actual error is.This commit adds
IntoInnerError::into_error()method that consumesIntoInnerErrorand returns containedio::Error. This mirrors the API ofstd::io::IntoInnerErrorin Rust stdlib, which provides such method.