Skip to main content

FileWriter

Enum FileWriter 

Source
pub enum FileWriter {
    V2_0(Box<Writer>),
    V2_1(Box<Writer>),
    V2_2(Box<Writer>),
    V2_3(Box<Writer>),
}
Expand description

A type-erased current-format file writer.

This enum exists for callers that select a concrete file version at runtime. Each variant owns the complete implementation for exactly one file grammar; this type only forwards operations without adding format policy.

Variants§

§

V2_0(Box<Writer>)

§

V2_1(Box<Writer>)

§

V2_2(Box<Writer>)

§

V2_3(Box<Writer>)

Implementations§

Source§

impl FileWriter

Source

pub fn with_page_metadata_spill( self, object_store: Arc<ObjectStore>, path: Path, ) -> Self

Spill page metadata to a sidecar file.

Source

pub async fn write_batches( &mut self, batches: impl Iterator<Item = &RecordBatch>, ) -> Result<()>

Schedule batches of data to be written to the file.

Source

pub async fn write_batch(&mut self, batch: &RecordBatch) -> Result<()>

Schedule a batch of data to be written to the file.

Source

pub async fn write_column( &mut self, column_index: usize, array: ArrayRef, ) -> Result<()>

Write one top-level column.

Source

pub async fn write_external_buffer( &mut self, bytes: &[u8], ) -> Result<(u64, u64)>

Append a buffer whose page or column metadata is supplied externally.

Source

pub fn add_schema_metadata( &mut self, key: impl Into<String>, value: impl Into<String>, )

Add a metadata entry to the schema.

Source

pub fn initialize_with_external_columns( &mut self, schema: Schema, columns: &[Arc<ColumnInfo>], rows_written: u64, ) -> Result<()>

Prepare a writer from encoded columns whose buffers were produced externally.

Source

pub async fn add_global_buffer(&mut self, buffer: Bytes) -> Result<u32>

Add an arbitrary global buffer and return its one-based index.

Source

pub async fn finish(&mut self) -> Result<FileWriteSummary>

Finish the file and close its object writer.

Source

pub async fn abort(&mut self)

Abandon the file write.

Source

pub async fn tell(&mut self) -> Result<u64>

Return the current object-writer position.

Source

pub fn field_id_to_column_indices(&self) -> &[(u32, u32)]

Return the field-id to physical-column mapping.

Trait Implementations§

Source§

impl From<Writer> for FileWriter

Source§

fn from(writer: Writer) -> Self

Converts to this type from the input type.
Source§

impl From<Writer> for FileWriter

Source§

fn from(writer: Writer) -> Self

Converts to this type from the input type.
Source§

impl From<Writer> for FileWriter

Source§

fn from(writer: Writer) -> Self

Converts to this type from the input type.
Source§

impl From<Writer> for FileWriter

Source§

fn from(writer: Writer) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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