Struct datafusion::common::arrow::ipc::writer::FileWriter
source · pub struct FileWriter<W>where
W: Write,{ /* private fields */ }
Implementations§
source§impl<W> FileWriter<W>where
W: Write,
impl<W> FileWriter<W>where
W: Write,
sourcepub fn try_new(writer: W, schema: &Schema) -> Result<FileWriter<W>, ArrowError>
pub fn try_new(writer: W, schema: &Schema) -> Result<FileWriter<W>, ArrowError>
Try create a new writer, with the schema written as part of the header
sourcepub fn try_new_with_options(
writer: W,
schema: &Schema,
write_options: IpcWriteOptions
) -> Result<FileWriter<W>, ArrowError>
pub fn try_new_with_options( writer: W, schema: &Schema, write_options: IpcWriteOptions ) -> Result<FileWriter<W>, ArrowError>
Try create a new writer with IpcWriteOptions
pub fn write_metadata( &mut self, key: impl Into<String>, value: impl Into<String> )
sourcepub fn write(&mut self, batch: &RecordBatch) -> Result<(), ArrowError>
pub fn write(&mut self, batch: &RecordBatch) -> Result<(), ArrowError>
Write a record batch to the file
sourcepub fn finish(&mut self) -> Result<(), ArrowError>
pub fn finish(&mut self) -> Result<(), ArrowError>
Write footer and closing tag, then mark the writer as done
sourcepub fn get_mut(&mut self) -> &mut W
pub fn get_mut(&mut self) -> &mut W
Gets a mutable reference to the underlying writer.
It is inadvisable to directly write to the underlying writer.
sourcepub fn into_inner(self) -> Result<W, ArrowError>
pub fn into_inner(self) -> Result<W, ArrowError>
Unwraps the BufWriter housed in FileWriter.writer, returning the underlying writer
The buffer is flushed and the FileWriter is finished before returning the writer.
Trait Implementations§
source§impl<W> RecordBatchWriter for FileWriter<W>where
W: Write,
impl<W> RecordBatchWriter for FileWriter<W>where
W: Write,
source§fn write(&mut self, batch: &RecordBatch) -> Result<(), ArrowError>
fn write(&mut self, batch: &RecordBatch) -> Result<(), ArrowError>
Write a single batch to the writer.
Auto Trait Implementations§
impl<W> Freeze for FileWriter<W>where
W: Freeze,
impl<W> RefUnwindSafe for FileWriter<W>where
W: RefUnwindSafe,
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>where
W: UnwindSafe,
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 more