Struct polars_arrow::io::ipc::write::file_async::FileSink
source · pub struct FileSink<'a, W: AsyncWrite + Unpin + Send + 'a> { /* private fields */ }Available on crate features
io_ipc and io_ipc_write_async only.Expand description
Sink that writes array chunks as an IPC file.
The file header is automatically written before writing the first chunk, and the file footer is automatically written when the sink is closed.
Implementations§
source§impl<'a, W> FileSink<'a, W>
impl<'a, W> FileSink<'a, W>
sourcepub fn new(
writer: W,
schema: ArrowSchema,
ipc_fields: Option<Vec<IpcField>>,
options: WriteOptions,
) -> Self
pub fn new( writer: W, schema: ArrowSchema, ipc_fields: Option<Vec<IpcField>>, options: WriteOptions, ) -> Self
Create a new file writer.
Trait Implementations§
source§impl<'a, W> Sink<Record<'_>> for FileSink<'a, W>
impl<'a, W> Sink<Record<'_>> for FileSink<'a, W>
§type Error = PolarsError
type Error = PolarsError
The type of value produced by the sink when an error occurs.
source§fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<PolarsResult<()>>
fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<PolarsResult<()>>
Attempts to prepare the
Sink to receive a value. Read moresource§fn start_send(self: Pin<&mut Self>, item: Record<'_>) -> PolarsResult<()>
fn start_send(self: Pin<&mut Self>, item: Record<'_>) -> PolarsResult<()>
Begin the process of sending a value to the sink.
Each call to this function must be preceded by a successful call to
poll_ready which returned Poll::Ready(Ok(())). Read moresource§fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<PolarsResult<()>>
fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<PolarsResult<()>>
Flush any remaining output from this sink. Read more
source§fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<PolarsResult<()>>
fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<PolarsResult<()>>
Flush any remaining output and close this sink, if necessary. Read more
Auto Trait Implementations§
impl<'a, W> Freeze for FileSink<'a, W>where
W: Freeze,
impl<'a, W> !RefUnwindSafe for FileSink<'a, W>
impl<'a, W> Send for FileSink<'a, W>
impl<'a, W> !Sync for FileSink<'a, W>
impl<'a, W> Unpin for FileSink<'a, W>
impl<'a, W> !UnwindSafe for FileSink<'a, W>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moresource§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T, Item> SinkExt<Item> for T
impl<T, Item> SinkExt<Item> for T
source§fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F>
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F>
Composes a function in front of the sink. Read more
source§fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F>
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F>
Composes a function in front of the sink. Read more
source§fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F>
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F>
Transforms the error returned by the sink.
source§fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E>
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E>
Map this sink’s error to a different error type using the
Into trait. Read moresource§fn buffer(self, capacity: usize) -> Buffer<Self, Item>where
Self: Sized,
fn buffer(self, capacity: usize) -> Buffer<Self, Item>where
Self: Sized,
Adds a fixed-size buffer to the current sink. Read more
source§fn flush(&mut self) -> Flush<'_, Self, Item>where
Self: Unpin,
fn flush(&mut self) -> Flush<'_, Self, Item>where
Self: Unpin,
Flush the sink, processing all pending items. Read more
source§fn send(&mut self, item: Item) -> Send<'_, Self, Item>where
Self: Unpin,
fn send(&mut self, item: Item) -> Send<'_, Self, Item>where
Self: Unpin,
A future that completes after the given item has been fully processed
into the sink, including flushing. Read more
source§fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>where
Self: Unpin,
fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>where
Self: Unpin,
A future that completes after the given item has been received
by the sink. Read more
source§fn send_all<'a, St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>
fn send_all<'a, St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>
A future that completes after the given stream has been fully processed
into the sink, including flushing. Read more
source§fn right_sink<Si1>(self) -> Either<Si1, Self>
fn right_sink<Si1>(self) -> Either<Si1, Self>
source§fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>,
) -> Poll<Result<(), Self::Error>>where
Self: Unpin,
fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>,
) -> Poll<Result<(), Self::Error>>where
Self: Unpin,
A convenience method for calling
Sink::poll_ready on Unpin
sink types.source§fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error>where
Self: Unpin,
fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error>where
Self: Unpin,
A convenience method for calling
Sink::start_send on Unpin
sink types.