Struct polars_io::ipc::IpcWriter

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

Available on crate features ipc or ipc_streaming 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");

    IpcWriter::new(&mut file)
        .finish(df)
}

Implementations

impl<W: Write> IpcWriter<W>

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

Set the compression used. Defaults to None.

pub fn with_pl_flavor(self, pl_flavor: bool) -> Self

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

impl<W: AsyncWrite + Unpin + Send> IpcWriter<W>

pub fn new_async(writer: W) -> Self

Available on crate features async and ipc only.

pub fn batched_async( self, schema: &Schema ) -> PolarsResult<BatchedWriterAsync<'_, W>>

Available on crate features async and ipc only.

Trait Implementations

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

where W: Write,

fn new(writer: W) -> Self

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