Struct polars::prelude::IpcWriter

source ·
pub struct IpcWriter<W> { /* private fields */ }
Available on crate feature polars-io only.
Expand description

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§

source§

impl<W> IpcWriter<W>
where W: Write,

source

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

Set the compression used. Defaults to None.

source

pub fn with_pl_flavor(self, pl_flavor: bool) -> IpcWriter<W>

source

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

Trait Implementations§

source§

impl<W> SerWriter<W> for IpcWriter<W>
where W: Write,

source§

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

source§

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

Auto Trait Implementations§

§

impl<W> Freeze for IpcWriter<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for IpcWriter<W>
where W: RefUnwindSafe,

§

impl<W> Send for IpcWriter<W>
where W: Send,

§

impl<W> Sync for IpcWriter<W>
where W: Sync,

§

impl<W> Unpin for IpcWriter<W>
where W: Unpin,

§

impl<W> UnwindSafe for IpcWriter<W>
where W: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V