Struct ReadStatWriter 

pub struct ReadStatWriter {
    pub(crate) wtr: Option<ReadStatWriterFormat>,
    pub(crate) wrote_header: bool,
    pub(crate) wrote_start: bool,
    config: WriteConfig,
    schema: SchemaRef,
    rows_written: usize,
    staging_path: Option<PathBuf>,
}

Manages writing Arrow [RecordBatch] data to the configured output format.

Supports streaming writes across multiple batches. The writer is created lazily on the first call to write and finalized via finish.

Fields

wtr: Option<ReadStatWriterFormat>

The format-specific writer, created on first write.

wrote_header: bool

Whether the CSV header row has been written.

wrote_start: bool

Whether any data has been written (controls file creation vs. append).

config: WriteConfig

schema: SchemaRef

rows_written: usize

staging_path: Option<PathBuf>

Implementations

impl ReadStatWriter

pub fn new( config: WriteConfig, schema: SchemaRef, ) -> Result<Self, ReadStatError>

Creates a new ReadStatWriter with no active writer.

fn open_output(&mut self, wc: &WriteConfig) -> Result<File, ReadStatError>

Opens a sibling staging file. Called exactly once per output; successful finalization publishes it to the configured destination.

fn resolve_compression( compression: Option<ParquetCompression>, compression_level: Option<u32>, ) -> Result<ParquetCompressionCodec, ReadStatError>

pub fn finish(self) -> Result<usize, ReadStatError>

Finalizes the writer, flushing and closing the underlying format writer.

Returns the total number of successfully written rows. Consuming the writer makes finalization a one-shot operation. The library does not print anything; callers own user-facing summary output.

Errors

Returns an error if the underlying writer fails to flush or close, or if the output format is not enabled.

fn publish(&mut self) -> Result<usize, ReadStatError>

fn flush_buffered(&mut self) -> Result<(), ReadStatError>

Flushes the buffered file writer for formats (CSV, NDJSON) whose underlying BufWriter would otherwise flush silently in Drop.

fn finish_feather(&mut self) -> Result<(), ReadStatError>

fn finish_parquet(&mut self) -> Result<(), ReadStatError>

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

Writes a single batch of data in the format determined by wc.

Handles writer initialization on first call and CSV header writing.

Errors

Returns an error if the output file cannot be opened, writing fails, or the output format is not enabled.

fn write_data_to_csv( &mut self, batch: &RecordBatch, wc: &WriteConfig, ) -> Result<(), ReadStatError>

fn write_data_to_feather( &mut self, batch: &RecordBatch, wc: &WriteConfig, ) -> Result<(), ReadStatError>

fn write_data_to_ndjson( &mut self, batch: &RecordBatch, wc: &WriteConfig, ) -> Result<(), ReadStatError>

fn write_data_to_parquet( &mut self, batch: &RecordBatch, wc: &WriteConfig, ) -> Result<(), ReadStatError>

fn write_data_to_stdout( &mut self, batch: &RecordBatch, ) -> Result<(), ReadStatError>

fn write_header_to_stdout(&mut self) -> Result<(), ReadStatError>

Trait Implementations

impl Drop for ReadStatWriter

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.