Prevent BufferedWriter from producing empty files #2677
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
Motivation: In the current implementation, if the users forget to call 'flush()' on the writer when creating a new file with 'withFileHandle(forWritingAt:options:execute)' the newly created file is empty. Modifications: - Added the 'withBufferedWriter()' method for the 'WritableFileHandleProtocol' and implemented it for the WriteFileHandle and 'ReadWriteFilehandle'. The method calls flush on the bufferedWriter after executing the closure that writes the contents to the file as indicated by the user. Result: Users can now use the 'withBufferedWriter' method instead of instantiating the bufferedWriter themselves, reducing the possibility of omitting 'flush()'. TO DO: - documentthe method - implement tests
|
@swift-server-bot add to allowlist |
glbrntt
requested changes
Mar 12, 2024
| /// | ||
| /// - Parameters: | ||
| /// - body: The closure that writes the contents to the buffer created in this method. | ||
| /// - Returns: The result of the executed closure. |
There was a problem hiding this comment.
Returns: shouldn't be indented here, otherwise it's treated as documentation for a parameter
glbrntt
added
the
🔼 needs-minor-version-bump
glbrntt
approved these changes
Mar 12, 2024
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.
Preventing BufferedWriter from producing empty files
Motivation:
In the current implementation, if the users forget to call 'flush()' on the writer when creating a new file with 'withFileHandle(forWritingAt:options:execute)' the newly created file is empty.
Modifications:
Implemented the 'withBufferedWriter()' method for the 'WriteFileHandle'. The method calls flush on the bufferedWriter after executing the closure that writes the contents to the buffer as indicated by the user.
Result:
Users can now use the 'withBufferedWriter' method instead of instantiating the bufferedWriter themselves, reducing the possibility of omitting 'flush()'.