Skip to content

Commit

Permalink
Minor: Add a link to RecordBatchStreamAdapter to `SendableRecordBatch…
Browse files Browse the repository at this point in the history
…Stream` (#14084)
  • Loading branch information
alamb authored Jan 13, 2025
1 parent 98e821c commit f9cc332
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions datafusion/execution/src/stream.rs
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ pub trait RecordBatchStream: Stream<Item = Result<RecordBatch>> {
/// `RecordBatch` returned by the stream should have the same schema as returned
/// by [`schema`](`RecordBatchStream::schema`).
///
/// # See Also
///
/// * [`RecordBatchStreamAdapter`] to convert an existing [`Stream`]
/// to [`SendableRecordBatchStream`]
///
/// [`RecordBatchStreamAdapter`]: https://docs.rs/datafusion/latest/datafusion/physical_plan/stream/struct.RecordBatchStreamAdapter.html
///
/// # Error Handling
///
/// Once a stream returns an error, it should not be polled again (the caller
Expand Down

0 comments on commit f9cc332

Please sign in to comment.