Struct arrow_ipc::writer::FileWriter

pub struct FileWriter<W: Write> { /* private fields */ }

Writer for an IPC file

Implementations

impl<W: Write> FileWriter<W>

pub fn try_new(writer: W, schema: &Schema) -> Result<Self, ArrowError>

Try to create a new writer, with the schema written as part of the header

pub fn try_new_with_options( writer: W, schema: &Schema, write_options: IpcWriteOptions, ) -> Result<Self, ArrowError>

Try to create a new writer with IpcWriteOptions

pub fn write_metadata( &mut self, key: impl Into<String>, value: impl Into<String>, )

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

Write a record batch to the file

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

Write footer and closing tag, then mark the writer as done

pub fn schema(&self) -> &SchemaRef

Returns the arrow SchemaRef for this arrow file.

pub fn get_ref(&self) -> &W

Gets a reference to the underlying writer.

pub fn get_mut(&mut self) -> &mut W

Gets a mutable reference to the underlying writer.

It is inadvisable to directly write to the underlying writer.

pub fn into_inner(self) -> Result<W, ArrowError>

Unwraps the BufWriter housed in FileWriter.writer, returning the underlying writer

The buffer is flushed and the FileWriter is finished before returning the writer.

Trait Implementations

impl<W: Write> RecordBatchWriter for FileWriter<W>

fn write(&mut self, batch: &RecordBatch) -> Result<(), ArrowError>

Write a single batch to the writer.

fn close(self) -> Result<(), ArrowError>

Write footer or termination data, then mark the writer as done.