Struct BatchStreamEncoder 

pub struct BatchStreamEncoder { /* private fields */ }

Incremental Arrow IPC encoder that writes the schema once: concatenating the per-call blobs in order yields one IPC stream for BatchStreamDecoder.

Implementations

impl BatchStreamEncoder

pub fn new(schema: &Schema) -> Result<Self, ArrowError>

Encoder for schema; the schema message flushes out with the first batch.

Errors

[ArrowError] if the schema header can’t be IPC-encoded.

pub fn schema(&self) -> &SchemaRef

Schema this encoder was created with; every encoded batch must match it.

pub fn encode(&mut self, batch: &RecordBatch) -> Result<Vec<u8>, ArrowError>

Encode one batch, returning the bytes written since the last call (the first call also carries the schema).

Errors

[ArrowError] if IPC encoding fails.

pub fn finish(&mut self) -> Result<Vec<u8>, ArrowError>

Finish the stream, returning the end-of-stream marker to append after the last encode. Also lets the decoder flush a trailing zero-row batch; no batches may be encoded after this.

Errors

[ArrowError] if writing the marker fails.