polars_io::ipc

Struct IpcStreamWriter

Source
pub struct IpcStreamWriter<W> { /* private fields */ }
Available on crate feature ipc_streaming and (crate features ipc or ipc_streaming) only.
Expand description

Write a DataFrame to Arrow’s Streaming IPC format

§Example

use polars_core::prelude::*;
use polars_io::ipc::IpcStreamWriter;
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 = IpcStreamWriter::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§

Source§

impl<W> IpcStreamWriter<W>

Source

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

Set the compression used. Defaults to None.

Source

pub fn with_compat_level(self, compat_level: CompatLevel) -> Self

Source

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

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

Trait Implementations§

Source§

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

Source§

fn new(writer: W) -> Self

Source§

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

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<W> UnwindSafe for IpcStreamWriter<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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T

§

impl<T> Ungil for T
where T: Send,