Struct IpcReader

pub struct IpcReader<R>
where
    R: MmapBytesReader,
{ /* private fields */ }

Available on crate feature polars-io only.

Read Arrows IPC format into a DataFrame

Example

use polars_core::prelude::*;
use std::fs::File;
use polars_io::ipc::IpcReader;
use polars_io::SerReader;

fn example() -> PolarsResult<DataFrame> {
    let file = File::open("file.ipc").expect("file not found");

    IpcReader::new(file)
        .finish()
}

Implementations

impl<R> IpcReader<R>

where R: MmapBytesReader,

pub fn schema(&mut self) -> Result<Arc<Schema<Field>>, PolarsError>

Get arrow schema of the Ipc File.

pub fn custom_metadata( &mut self, ) -> Result<Option<Arc<BTreeMap<PlSmallStr, PlSmallStr>>>, PolarsError>

Get schema-level custom metadata of the Ipc file

pub fn with_n_rows(self, num_rows: Option<usize>) -> IpcReader<R>

Stop reading when n rows are read.

pub fn with_columns(self, columns: Option<Vec<String>>) -> IpcReader<R>

Columns to select/ project

pub fn with_hive_partition_columns( self, columns: Option<Vec<Series>>, ) -> IpcReader<R>

pub fn with_include_file_path( self, include_file_path: Option<(PlSmallStr, Arc<str>)>, ) -> IpcReader<R>

pub fn with_row_index(self, row_index: Option<RowIndex>) -> IpcReader<R>

Add a row index column.

pub fn with_projection(self, projection: Option<Vec<usize>>) -> IpcReader<R>

Set the reader’s column projection. This counts from 0, meaning that vec![0, 4] would select the 1st and 5th column.

pub fn memory_mapped(self, path_buf: Option<PathBuf>) -> IpcReader<R>

Set if the file is to be memory_mapped. Only works with uncompressed files. The file name must be passed to register the memory mapped file.

pub fn finish_with_scan_ops( self, predicate: Option<Arc<dyn PhysicalIoExpr>>, verbose: bool, ) -> Result<DataFrame, PolarsError>

Available on crate feature lazy only.

Trait Implementations

impl<R> SerReader<R> for IpcReader<R>

where R: MmapBytesReader,

fn new(reader: R) -> IpcReader<R>

Create a new instance of the SerReader

fn set_rechunk(self, rechunk: bool) -> IpcReader<R>

Make sure that all columns are contiguous in memory by aggregating the chunks into a single array.

fn finish(self) -> Result<DataFrame, PolarsError>

Take the SerReader and return a parsed DataFrame.