From f9cc3325cdb5891b7566a6f3503c1f7ac6ad51e0 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Sun, 12 Jan 2025 20:55:25 -0500 Subject: [PATCH] Minor: Add a link to RecordBatchStreamAdapter to `SendableRecordBatchStream` (#14084) --- datafusion/execution/src/stream.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/datafusion/execution/src/stream.rs b/datafusion/execution/src/stream.rs index f3eb7b77e03c..5b309210aa37 100644 --- a/datafusion/execution/src/stream.rs +++ b/datafusion/execution/src/stream.rs @@ -40,6 +40,13 @@ pub trait RecordBatchStream: Stream> { /// `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