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.
IOException
as the error type instead ofException
. Non-IO exceptions are now considered defects as they only occur due to misuse of the API.Buffer
usage 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 useException
for 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 withOption
to indicate end-of-stream when reading, instead of-1
magic value.java.io.EOFException
. TheeofOption
method can be used to turn anEOFException
failure into a success withNone
if the user wants that.