Struct ArrowRecordBatchIpcStreamFormat 

pub struct ArrowRecordBatchIpcStreamFormat { /* private fields */ }

Available on crate feature arrow only.

Arrow record batches in IPC stream framing.

Encoding needs the schema up front, because it is written once ahead of the first batch. Decoding does not: the schema arrives in the stream.

Implementations

impl ArrowRecordBatchIpcStreamFormat

pub fn new(schema: Arc<Schema>) -> Self

A format writing batches of schema with default IPC options.

pub fn with_options(schema: Arc<Schema>, options: IpcWriteOptions) -> Self

A format writing batches of schema with the given IPC options.

pub fn for_decoding() -> Self

A format for decoding only.

An Arrow IPC stream carries its own schema, so a decoder needs none. Named for what it is rather than offered as a Default, because encoding with it would write an empty schema and produce a useless stream.

Trait Implementations

impl Clone for ArrowRecordBatchIpcStreamFormat

fn clone(&self) -> ArrowRecordBatchIpcStreamFormat

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArrowRecordBatchIpcStreamFormat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DefaultFormat for ArrowRecordBatchIpcStreamFormat

fn default_format() -> Self

Decoding needs no configuration; see for_decoding.

impl StreamFormat for ArrowRecordBatchIpcStreamFormat

fn format_name(&self) -> &'static str

A short, stable name, reported as the format tracing field.

fn default_content_type(&self) -> &'static str

The Content-Type this format emits when encoding.

fn accepts_content_type(&self, ct: &ContentType<'_>) -> bool

Whether an incoming Content-Type should be accepted as this format.

impl StreamFormatDecode<RecordBatch> for ArrowRecordBatchIpcStreamFormat

type Frame = Result<RecordBatch, StreamError>

One framed record, before deserialisation.

type Framer = ArrowIpcCodec

Splits the body into records.

type Parser = IdentityParser

Deserialises framed records.

fn framer(&self, options: &DecodeOptions) -> Self::Framer

Build a framer for one body.

fn parser(&self) -> Self::Parser

Build a parser for one body.

impl StreamFormatEncode<RecordBatch> for ArrowRecordBatchIpcStreamFormat

type Encoder = ArrowIpcEncoder

The per-stream encoder. A fresh one is built for every body, because framing state (item index, Arrow’s dictionary tracker, CSV’s header flag) is per-stream.

fn encoder(&self) -> Self::Encoder

Build an encoder for one body.