Trait RecordBatchReader

pub trait RecordBatchReader: Iterator<Item = Result<RecordBatch, ArrowError>> {
    // Required method
    fn schema(&self) -> Arc<Schema>;

    // Provided method
    fn next_batch(&mut self) -> Result<Option<RecordBatch>, ArrowError> { ... }
}

Trait for types that can read RecordBatch’s.

To create from an iterator, see RecordBatchIterator.

Required Methods

fn schema(&self) -> Arc<Schema>

Returns the schema of this RecordBatchReader.

Implementation of this trait should guarantee that all RecordBatch’s returned by this reader should have the same schema as returned from this method.

Provided Methods

fn next_batch(&mut self) -> Result<Option<RecordBatch>, ArrowError>

👎Deprecated since 2.0.0: This method is deprecated in favour of next from the trait Iterator.

Reads the next RecordBatch.

Trait Implementations

impl IntoPyArrow for Box<dyn RecordBatchReader + Send>

Convert a RecordBatchReader into a pyarrow.RecordBatchReader.

fn into_pyarrow(self, py: Python<'_>) -> PyResult<PyObject>

Convert the implemented type into a Python object while consuming it.

Implementations on Foreign Types

impl<R> RecordBatchReader for Reader<R>

where R: BufRead,

fn schema(&self) -> Arc<Schema>

impl<R> RecordBatchReader for Box<R>

where R: RecordBatchReader + ?Sized,

fn schema(&self) -> Arc<Schema>

impl<R> RecordBatchReader for BufReader<R>

where R: BufRead,

fn schema(&self) -> Arc<Schema>

impl<R> RecordBatchReader for FileReader<R>

where R: Read + Seek,

fn schema(&self) -> Arc<Schema>

impl<R> RecordBatchReader for StreamReader<R>

where R: Read,

fn schema(&self) -> Arc<Schema>

Implementors

impl RecordBatchReader for ArrowArrayStreamReader

impl<I> RecordBatchReader for RecordBatchIterator<I>

where I: IntoIterator<Item = Result<RecordBatch, ArrowError>>,