Struct polars::export::arrow::io::ipc::write::FileWriter

source · [−]

pub struct FileWriter<W> where
    W: Write,  { /* private fields */ }

This is supported on crate feature io_ipc only.

Expand description

Arrow file writer

Implementations

source

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

source

pub fn try_new(
 writer: W,
 schema: &Schema,
 ipc_fields: Option<Vec<IpcField, Global>>,
 options: WriteOptions
) -> Result<FileWriter<W>, ArrowError>

Try create a new writer, with the schema written as part of the header

source

pub fn into_inner(self) -> W

Consumes itself into the inner writer

source

pub fn write(
 &mut self,
 columns: &Chunk<Arc<dyn Array + 'static>>,
 ipc_fields: Option<&[IpcField ]>
) -> Result<(), ArrowError>

Writes Chunk to the file

source

pub fn finish(&mut self) -> Result<(), ArrowError>

Write footer and closing tag, then mark the writer as done

Auto Trait Implementations

impl<W> !RefUnwindSafe for FileWriter<W>

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

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

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

impl<W> !UnwindSafe for FileWriter<W>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

source

Struct polars::export::arrow::io::ipc::write::FileWriter

Implementations

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

pub fn try_new(
    writer: W,
    schema: &Schema,
    ipc_fields: Option<Vec<IpcField, Global>>,
    options: WriteOptions
) -> Result<FileWriter<W>, ArrowError>

pub fn into_inner(self) -> W

pub fn write(
    &mut self,
    columns: &Chunk<Arc<dyn Array + 'static>>,
    ipc_fields: Option<&[IpcField ]>
) -> Result<(), ArrowError>

pub fn finish(&mut self) -> Result<(), ArrowError>

Auto Trait Implementations

impl<W> !RefUnwindSafe for FileWriter<W>

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

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

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

impl<W> !UnwindSafe for FileWriter<W>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

Struct polars::export::arrow::io::ipc::write::FileWriter

Implementations

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

pub fn try_new( writer: W, schema: &Schema, ipc_fields: Option<Vec<IpcField, Global>>, options: WriteOptions) -> Result<FileWriter<W>, ArrowError>

pub fn into_inner(self) -> W

pub fn write( &mut self, columns: &Chunk<Arc<dyn Array + 'static>>, ipc_fields: Option<&[IpcField]>) -> Result<(), ArrowError>

pub fn finish(&mut self) -> Result<(), ArrowError>

Auto Trait Implementations

impl<W> !RefUnwindSafe for FileWriter<W>

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

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

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

impl<W> !UnwindSafe for FileWriter<W>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

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

pub fn try_new(
writer: W,
schema: &Schema,
ipc_fields: Option<Vec<IpcField, Global>>,
options: WriteOptions
) -> Result<FileWriter<W>, ArrowError>

pub fn write(
&mut self,
columns: &Chunk<Arc<dyn Array + 'static>>,
ipc_fields: Option<&[IpcField ]>
) -> Result<(), ArrowError>

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

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

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

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

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

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

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

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

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

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