Struct parquet2::write::FileStreamer
source · pub struct FileStreamer<W: AsyncWrite + Unpin + Send> { /* private fields */ }Available on crate feature
async only.Expand description
An interface to write a parquet file asynchronously.
Use start to write the header, write to write a row group,
and end to write the footer.
Implementations§
source§impl<W: AsyncWrite + Unpin + Send> FileStreamer<W>
impl<W: AsyncWrite + Unpin + Send> FileStreamer<W>
sourcepub fn options(&self) -> &WriteOptions
pub fn options(&self) -> &WriteOptions
The options assigned to the file
sourcepub fn schema(&self) -> &SchemaDescriptor
pub fn schema(&self) -> &SchemaDescriptor
The SchemaDescriptor assigned to this file
source§impl<W: AsyncWrite + Unpin + Send> FileStreamer<W>
impl<W: AsyncWrite + Unpin + Send> FileStreamer<W>
sourcepub fn new(
writer: W,
schema: SchemaDescriptor,
options: WriteOptions,
created_by: Option<String>
) -> Self
pub fn new( writer: W, schema: SchemaDescriptor, options: WriteOptions, created_by: Option<String> ) -> Self
Returns a new FileStreamer.
sourcepub async fn write<E>(&mut self, row_group: RowGroupIter<'_, E>) -> Result<()>where
Error: From<E>,
E: Error,
pub async fn write<E>(&mut self, row_group: RowGroupIter<'_, E>) -> Result<()>where Error: From<E>, E: Error,
Writes a row group to the file.
sourcepub async fn end(
&mut self,
key_value_metadata: Option<Vec<KeyValue>>
) -> Result<u64>
pub async fn end( &mut self, key_value_metadata: Option<Vec<KeyValue>> ) -> Result<u64>
Writes the footer of the parquet file. Returns the total size of the file and the underlying writer.
sourcepub fn into_inner(self) -> W
pub fn into_inner(self) -> W
Returns the underlying writer.