Make reformat return a ByteString
#720
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
In the early days, `reformat` simply returned the `Builder` contained in `PrintState`, thus it was reasonable for the return type of `reformat` to be `Builder`. However, `reformat` started changing `Builder` to `ByteString` once, manipulating it, and then back to `Builder` again, in order to support prefixes and such. This was not very reasonable, and instead, I thought it would be better to simply return `ByteString` since it would be easier for the user to use it. I am not familiar with the topic of lazy vs strict. The reason why I made `reformat` return the strict version is that `reformat` accepts the same type of value as an argument. However, since `Builder` can only convert to lazy ByteString, perhaps it is more convenient to return the lazy version.
mihaimaruseac
approved these changes
Apr 30, 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.
Description of the PR
Makes
reformatreturn aByteString.In the early days,
reformatsimply returned theBuildercontained inPrintState, therefore it was reasonable for the return type ofreformatto beBuilder. However,reformatstarted changingBuildertoByteStringonce, manipulating it, and then back toBuilderagain, in order to support prefixes and such. Thus, returning aBuilderbecame not very reasonable, and instead, I thought it would be better to simply return theByteStringsince it would be easier for the user to use it.I am not familiar with the topic of lazy vs strict. The reason why I made
reformatreturn the strict version is thatreformataccepts the same type of value as an argument. However, sinceBuildercan only convert to lazy ByteString, perhaps it is more convenient to return the lazy version.Checklist