Struct re_viewer::external::arrow2::io::ipc::write::StreamWriter

pub struct StreamWriter<W>
where
    W: Write,
{
    writer: W,
    write_options: WriteOptions,
    finished: bool,
    dictionary_tracker: DictionaryTracker,
    ipc_fields: Option<Vec<IpcField>>,
}

Arrow stream writer

The data written by this writer must be read in order. To signal that no more data is arriving through the stream call self.finish();

For a usage walkthrough consult this example.

Fields

writer: W

write_options: WriteOptions

finished: bool

dictionary_tracker: DictionaryTracker

ipc_fields: Option<Vec<IpcField>>

Implementations

impl<W> StreamWriter<W>

where W: Write,

pub fn new(writer: W, write_options: WriteOptions) -> StreamWriter<W>

Creates a new StreamWriter

pub fn start( &mut self, schema: &Schema, ipc_fields: Option<Vec<IpcField>> ) -> Result<(), Error>

Starts the stream by writing a Schema message to it. Use ipc_fields to declare dictionary ids in the schema, for dictionary-reuse

pub fn write( &mut self, columns: &Chunk<Box<dyn Array>>, ipc_fields: Option<&[IpcField]> ) -> Result<(), Error>

Writes Chunk to the stream

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

Write continuation bytes, and mark the stream as done

pub fn into_inner(self) -> W

Consumes itself, returning the inner writer.