Skip to main content

ArrowBatchBuilder

Struct ArrowBatchBuilder 

Source
pub struct ArrowBatchBuilder { /* private fields */ }
Expand description

Incremental Arrow RecordBatch builder.

Rows are pushed one at a time via push_row. Call finish to produce a RecordBatch and reset the builder.

The builder validates that each row’s length matches the schema.

Implementations§

Source§

impl ArrowBatchBuilder

Source

pub fn new(schema: SchemaRef) -> Result<Self, ArrowError>

Create a new builder for the given schema.

Returns an error if the schema contains unsupported data types.

Source

pub fn schema(&self) -> &SchemaRef

The schema this builder produces.

Source

pub fn len(&self) -> usize

Number of rows appended since the last finish.

Source

pub fn is_empty(&self) -> bool

Returns true if no rows have been appended.

Source

pub fn push_row(&mut self, values: &[ArrowValue]) -> Result<(), ArrowError>

Append a row of values.

Returns ArrowError::SchemaError if the row length doesn’t match the schema, or if a value type doesn’t match its column’s data type.

Source

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

Consume the accumulated rows and produce a RecordBatch.

The builder is reset and can be reused for the next batch.

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