improve ByteBuffer documentation regarding CoW on slices #359
Conversation
This file contains hidden or 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
Motivation: We got a very valid question on Twitter (https://twitter.com/karim_elna/status/989516133421199361) regarding ByteBuffers 'sharing storage'. Our docs almost sound like a ByteBuffer and its slices share storage even after a write. Especially given that this is a difference to Netty, we should document this better. Modifications: Added clarifying documentation. Result: Hopefully the docs are more clear now.
normanmaurer
approved these changes
Apr 26, 2018
Member
|
@swift-nio-bot test this please |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Motivation:
We got a very valid question on Twitter
(https://twitter.com/karim_elna/status/989516133421199361) regarding
ByteBuffers 'sharing storage'. Our docs almost sound like a ByteBuffer
and its slices share storage even after a write. Especially given that
this is a difference to Netty, we should document this better.
Modifications:
Added clarifying documentation.
Result:
Hopefully the docs are more clear now.