Struct parquet2::write::FileWriter

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

An interface to write a parquet file. Use start to write the header, write to write a row group, and end to write the footer.

Implementations

impl<W: Write> FileWriter<W>

pub fn options(&self) -> &WriteOptions

The options assigned to the file

pub fn schema(&self) -> &SchemaDescriptor

The SchemaDescriptor assigned to this file

impl<W: Write> FileWriter<W>

pub fn new(
    writer: W,
    schema: SchemaDescriptor,
    options: WriteOptions,
    created_by: Option<String>
) -> Self

Returns a new FileWriter.

pub fn start(&mut self) -> Result<()>

Writes the header of the file

pub fn write<E>(
    &mut self,
    row_group: RowGroupIter<'_, E>,
    num_rows: usize
) -> Result<()> where
    ParquetError: From<E>,
    E: Error, 

Writes a row group to the file.

This call is IO-bounded

pub fn end(self, key_value_metadata: Option<Vec<KeyValue>>) -> Result<(u64, W)>

Writes the footer of the parquet file. Returns the total size of the file and the underlying writer.