Struct ResultStream 

pub struct ResultStream { /* private fields */ }

Streaming result handle for pull-based chunk consumption.

Created by StreamingExecutionEngine::into_stream(). The caller pulls chunks one at a time via next_chunk(), enabling the API layer to stream results back without materialising the full result set. Call close() or let the handle drop to clean up resources.

When a full materialised DataSet is needed, use collect().

Implementations

impl ResultStream

pub fn new( engine: StreamingExecutionEngine, runtime: Arc<ExecutionRuntime>, ) -> Self

Wrap an engine into a streaming result.

The engine must have a root executor registered. The stream takes ownership of the engine and calls open() on the first next_chunk() call (or immediately if open_now is true).

pub fn from_collected( chunks: Vec<DataChunk>, engine: StreamingExecutionEngine, runtime: Arc<ExecutionRuntime>, ) -> Self

Create a stream from pre-collected chunks (used for partitioned fallback).

The chunks are served one at a time via next_chunk(). The engine is retained for proper cleanup via close_inner().

pub fn next_chunk(&mut self) -> Result<Option<DataChunk>, QueryError>

Pull the next chunk of results.

Returns Ok(None) when the stream is exhausted. The runtime’s cancel token is checked on each call.

pub fn close(&mut self) -> Result<(), QueryError>

Close the stream and release resources.

pub fn collect(self) -> Result<DataSet, QueryError>

Consume the stream and materialise all remaining chunks into a DataSet.

Routes through LocalChunkCollector, the single terminal collection logic shared with convert_chunks_to_dataset.

Trait Implementations

impl Drop for ResultStream

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.