Struct IpcWriter

pub struct IpcWriter<W> { /* private fields */ }

Available on crate feature polars-io only.

Write a DataFrame to Arrow’s IPC format

Example

use polars_core::prelude::*;
use polars_io::ipc::IpcWriter;
use std::fs::File;
use polars_io::SerWriter;

fn example(df: &mut DataFrame) -> PolarsResult<()> {
    let mut file = File::create("file.ipc").expect("could not create file");

    let mut writer = IpcWriter::new(&mut file);

    let custom_metadata = [
        ("first_name".into(), "John".into()),
        ("last_name".into(), "Doe".into()),
    ]
    .into_iter()
    .collect();
    writer.set_custom_schema_metadata(Arc::new(custom_metadata));
    writer.finish(df)
}

Implementations

impl<W> IpcWriter<W>

where W: Write,

pub fn with_compression( self, compression: Option<IpcCompression>, ) -> IpcWriter<W>

Set the compression used. Defaults to None.

pub fn with_compat_level(self, compat_level: CompatLevel) -> IpcWriter<W>

pub fn with_parallel(self, parallel: bool) -> IpcWriter<W>

pub fn batched( self, schema: &Schema<DataType>, ) -> Result<BatchedWriter<W>, PolarsError>

pub fn set_custom_schema_metadata( &mut self, custom_metadata: Arc<BTreeMap<PlSmallStr, PlSmallStr>>, )

Sets custom schema metadata. Must be called before start is called

Trait Implementations

impl<W> SerWriter<W> for IpcWriter<W>

where W: Write,

fn new(writer: W) -> IpcWriter<W>

fn finish(&mut self, df: &mut DataFrame) -> Result<(), PolarsError>