Improve API consistency and docs. #228
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
quelgar
force-pushed
the
quelgar/api-cleanup
branch
3 times, most recently
from
029583f
to
81e77c4
Compare
* Change most APIs to use `IOException` as the error type instead of `Exception`. Non-IO exceptions are now considered defects as they only occur due to misuse of the API. * Similarly change incorrect `Buffer` usage errors to be defects instead of failures. * The `Async*` classes still use `Exception` for the error type for now, as the NIO Javadocs are vague as to what kind of exceptions to expect from these. * Rename various read and write methods so they match the underlying NIO methods. Seems clearer. * Add various Scaladocs (more still needed). * Use `Option` to indicate end-of-stream when reading, instead of `-1` magic value.
End-of-stream is now handled in a consistent way across all read APIs. If a read encounters end-of-stream, the effect will fail with a `java.io.EOFException`.
quelgar
force-pushed
the
quelgar/api-cleanup
branch
from
81e77c4
to
a303c28
Compare
jdegoes
approved these changes
Sep 3, 2020
|
Thanks for your work on this! |
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.
I started a branch where I tried to cleanup the APIs, make things more consistent and add some docs. I belatedly realised it was going to be a rather large PR. I'm happy to rollback individual elements if there's no agreement on them.
IOExceptionas the error type instead ofException. Non-IO exceptions are now considered defects as they only occur due to misuse of the API.Bufferusage errors to be defects instead of failures.I found in practice I would always turn the usage mistake exceptions into defects anyway.
Async*classes still useExceptionfor the error type for now, as the NIO Javadocs are vague as to what kind of exceptions to expect from these.Buffer-based read/write methods public where they aren't already, according to the "unopinionated" principle.UseChanged all read methods to indicate end-of-stream by failing withOptionto indicate end-of-stream when reading, instead of-1magic value.java.io.EOFException. TheeofOptionmethod can be used to turn anEOFExceptionfailure into a success withNoneif the user wants that.