implement close-semantic for EncWriter / DecWriter
#18
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
This commit implements the close-semantic for `EncWriter` and `DecWriter` such that both implement the internal `Close` trait but not the public/exported `Close` trait. Instead both provide a `close(mut self)` method that has the same semantics as the `close` method defined by (both) `Close` traits but takes ownership of the `EncWriter` / `DecWriter`. Further any type (`std::io::Write`) that should be wrapped with an `EncWriter` / `DecWriter` must implement the (internal) `Close` trait. Since this is not possible (the trait is private), we implement the internal `Close` trait for any type that implements the public/exported `Close` trait. For further details see issue: #17. Further this commit adds the `NopCloser` type that can wrap any `std::io::Write` and implements `Close`. This commit also adds some documentation. Update #17
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.
What does the PR do?
This commit implements the close-semantic for
EncWriterandDecWritersuch that both implementthe internal
Closetrait but not the public/exportedClosetrait. Instead both provide aclose(mut self)method that has the same semantics as the
closemethod defined by (both)
Closetraits but takes ownershipof the
EncWriter/DecWriter.Further any type (
std::io::Write) that should be wrappedwith an
EncWriter/DecWritermust implement the(internal)
Closetrait. Since this is not possible(the trait is private), we implement the internal
Closetrait for any type that implements the public/exportedClosetrait. For further details see issue: #17.Further this commit adds the
NopClosertype that canwrap any
std::io::Writeand implementsClose.This commit also adds some documentation.
What problem does it solve?
Update #17