docs: add an example for RecordBatchReceiverStreamBuilder #8888
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
SteveLauC
commented
Jan 17, 2024
| @@ -156,14 +156,62 @@ impl<O: Send + 'static> ReceiverStreamBuilder<O> { | |||
| } | |||
| } | |||
|
|
|||
| /// Builder for [`RecordBatchReceiverStream`] that propagates errors | |||
| /// Builder for `RecordBatchReceiverStream` that propagates errors | |||
There was a problem hiding this comment.
This [] is removed because there is no item named RecordBatchReceiverStream, the RecordBatchReceiverStreamBuilder::build() will return a trait object rather than a concrete type.
There was a problem hiding this comment.
Oops, I just realized that this item exists, it is just hidden from the documents:
#[doc(hidden)]
pub struct RecordBatchReceiverStream {}
SteveLauC
commented
Jan 17, 2024
| @@ -209,7 +259,7 @@ impl RecordBatchReceiverStreamBuilder { | |||
| self.inner.spawn_blocking(f) | |||
| } | |||
|
|
|||
| /// runs the input_partition of the `input` ExecutionPlan on the | |||
| /// runs the `partition` of the `input` ExecutionPlan on the | |||
There was a problem hiding this comment.
This change is to match the argument name of this run_input() function
SteveLauC
force-pushed
the
physical_plan_stream
branch
from
6466168
to
a507d8c
Compare
9 tasks
|
Thank you for this @SteveLauC -- it is really appreciated that you are making it easier for others to use DataFusion based on experience / rough edges you encounter. |
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?
No
Rationale for this change
I was quite confused about how to this type when I first saw it, so let's add an example to make it more clear on its usage.
What changes are included in this PR?
RecordBatchReceiverStreamBuilderAre these changes tested?
Yes, tested with
cargo tAre there any user-facing changes?
No