Document that useAsCStringLen does not append NUL #612
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
clyring
reviewed
Sep 15, 2023
Data/ByteString.hs
Outdated
| -- It must not be stored or used after the subcomputation finishes. | ||
| -- | ||
| -- Beware that this function does not add a terminating @\NUL@ byte at the end of 'CStringLen'. |
There was a problem hiding this comment.
It looks like the implementation actually does currently append a null byte, but I agree that doing so is not part of this function's contract.
Suggested change
| -- Beware that this function does not add a terminating @\NUL@ byte at the end of 'CStringLen'. | |
| -- Beware that this function is not required to add a terminating @\NUL@ byte at the end of the 'CStringLen' it provides. |
There was a problem hiding this comment.
Right, it's ShortByteString version who does not add it, but ByteString one currently does.
Co-authored-by: Matthew Craven <[email protected]>
clyring
approved these changes
Sep 15, 2023
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.
Following up on haskell/unix#295 (comment).