Minor: add additional documentation about BufWriter
#5519
Merged
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
alamb
added
documentation
alamb
changed the title
BufWriter
alamb
commented
Mar 15, 2024
|
|
||
| /// An async buffered writer compatible with the tokio IO traits | ||
| /// | ||
| /// This writer adaptively uses [`ObjectStore::put`] or |
Contributor
Author
There was a problem hiding this comment.
this is such an important feature I think it is worth calling out explicitly
alamb
commented
Mar 15, 2024
tustvold
reviewed
Mar 15, 2024
Contributor
tustvold
left a comment
tustvold
left a comment
There was a problem hiding this comment.
Just a minor copy suggestion, I think we should highlight that they're a compatibility tool and not hugely recommended
Co-authored-by: Raphael Taylor-Davies <[email protected]>
alamb
added a commit
to alamb/arrow-rs
that referenced
this pull request
Mar 20, 2025
* Minor: add additional documentation about BufWriter * Update object_store/src/buffered.rs * Apply suggestions from code review Co-authored-by: Raphael Taylor-Davies <[email protected]> * Format --------- Co-authored-by: Raphael Taylor-Davies <[email protected]> Co-authored-by: Raphael Taylor-Davies <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Which issue does this PR close?
Closes #.
Rationale for this change
Inspired by apache/datafusion#9614, I wanted to make it clearer that BufWriter existed / what it could do
What changes are included in this PR?
BufReaderandBufWriterBufReaderto mention it adaptively used put / put multi-partAre there any user-facing changes?
Docs
No code / behavior changes