Improve GenericStringBuilder documentation
#6372
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
tustvold
approved these changes
Sep 9, 2024
Co-authored-by: Raphael Taylor-Davies <[email protected]>
alamb
commented
Sep 9, 2024
| @@ -227,30 +243,51 @@ impl<T: ByteArrayType, V: AsRef<T::Native>> Extend<Option<V>> for GenericByteBui | |||
| /// Values can be appended using [`GenericByteBuilder::append_value`], and nulls with | |||
| /// [`GenericByteBuilder::append_null`]. | |||
| /// | |||
| /// Additionally, implements [`std::fmt::Write`] with any written data included in the next | |||
| /// appended value. This allows use with [`std::fmt::Display`] without intermediate allocations | |||
| /// This builder also implements [`std::fmt::Write`] with any written data | |||
There was a problem hiding this comment.
The point of the PR was to make this feature clearer
| /// with standard Rust idioms like `write!` and `writeln!` to write data | ||
| /// directly to the builder without intermediate allocations. | ||
| /// | ||
| /// # Example writing strings with `append_value` |
There was a problem hiding this comment.
This style is by far the most common in DataFusion (and I think in other systems)
| /// assert_eq!(array.value(1), "v2"); | ||
| /// ``` | ||
| /// | ||
| /// # Example incrementally writing strings with `std::fmt::Write` |
There was a problem hiding this comment.
This style could be used for certain kernels, so I think it is better t have it as its own example
|
Thank you for the (quick) review @tustvold |
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.
Which issue does this PR close?
Closes #6347
Rationale for this change
I couldn't quickly discover that it was possible to incrementally build up strings with
GenericStringBuilderfrom the documentationWhat changes are included in this PR?
Are there any user-facing changes?
Documentation change only, no functional changes