Struct DataFrameStream 

pub struct DataFrameStream { /* private fields */ }

Incremental batch source and stream contracts. Incremental DataFrame result stream with one-way, repeatable terminal outcomes.

Implementations

impl DataFrameStream

pub fn from_factory( factory: &dyn BatchSourceFactory, options: StreamOptions, ) -> Result<Self>

Open a source factory after a compiler has already reported Supported eligibility.

pub fn schema(&self) -> SchemaRef

Return the source schema while the stream remains open or terminal.

pub fn status(&self) -> StreamTerminal

Return the current lifecycle state.

pub fn budget(&self) -> &ResourceBudget

Return the shared budget used by this stream.

pub fn next_batch(&mut self) -> Result<Option<DataFrame>>

Yield the next finite DataFrame batch, or None after normal exhaustion.

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

Close an open stream. Repeated close calls are successful and never reopen a source.

pub fn cancel(&mut self) -> Result<()>

Cancel an open stream. Repeated cancellation is successful and never reopens a source.

Trait Implementations

impl Drop for DataFrameStream

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.