Struct StreamResult 

pub struct StreamResult {
    pub output_schema: SchemaRef,
    pub input_schema: Option<SchemaRef>,
    pub state: StreamStateKind,
    pub header: Option<RecordBatch>,
    pub header_metadata: Option<Metadata>,
}

What a streaming method returns after init: its output/input schemas, an optional header, and the state object.

Fields

output_schema: SchemaRef

input_schema: Option<SchemaRef>

None for producer streams, or a schema for exchange streams.

state: StreamStateKind

header: Option<RecordBatch>

Optional 1-row header batch produced at stream start.

header_metadata: Option<Metadata>

Arbitrary metadata to attach to the header batch.

Implementations

impl StreamResult

pub fn producer(schema: SchemaRef, state: Box<dyn ProducerState>) -> Self

pub fn exchange( output_schema: SchemaRef, input_schema: SchemaRef, state: Box<dyn ExchangeState>, ) -> Self

pub fn with_header(self, header: RecordBatch) -> Self