Struct PyRecordBatchReader 

pub struct PyRecordBatchReader(/* private fields */);

A Python-facing Arrow record batch reader.

This is a wrapper around a RecordBatchReader.

Implementations

impl PyRecordBatchReader

pub fn new(reader: Box<dyn RecordBatchReader + Send>) -> Self

Construct a new PyRecordBatchReader from an existing RecordBatchReader.

pub fn from_arrow_pycapsule(capsule: &Bound<'_, PyCapsule>) -> PyResult<Self>

Construct from a raw Arrow C Stream capsule

pub fn into_reader(self) -> PyResult<Box<dyn RecordBatchReader + Send>>

Consume this reader and convert into a RecordBatchReader.

The reader can only be consumed once. Calling into_reader

pub fn into_table(self) -> PyArrowResult<PyTable>

Consume this reader and create a PyTable object

pub fn schema_ref(&self) -> PyResult<SchemaRef>

Access the SchemaRef of this RecordBatchReader.

If the stream has already been consumed, this method will error.

pub fn to_arro3<'py>(&'py self, py: Python<'py>) -> PyResult<Bound<'py, PyAny>>

Export this to a Python arro3.core.RecordBatchReader.

pub fn into_arro3(self, py: Python<'_>) -> PyResult<Bound<'_, PyAny>>

Export this to a Python arro3.core.RecordBatchReader.

pub fn to_nanoarrow<'py>( &'py self, py: Python<'py>, ) -> PyResult<Bound<'py, PyAny>>

Export this to a Python nanoarrow.ArrayStream.

pub fn into_pyarrow(self, py: Python<'_>) -> PyResult<Bound<'_, PyAny>>

Export to a pyarrow.RecordBatchReader

Requires pyarrow >=15

Trait Implementations

impl Display for PyRecordBatchReader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Box<dyn RecordBatchReader<Item = Result<RecordBatch, ArrowError>> + Send>> for PyRecordBatchReader

fn from(value: Box<dyn RecordBatchReader + Send>) -> Self

Converts to this type from the input type.

impl From<PyRecordBatchReader> for Arro3RecordBatchReader

fn from(value: PyRecordBatchReader) -> Self

Converts to this type from the input type.

impl<'a> FromPyObject<'a> for PyRecordBatchReader

fn extract_bound(ob: &Bound<'a, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for PyRecordBatchReader

type Target = PyRecordBatchReader

The Python output type

type Output = Bound<'py, <PyRecordBatchReader as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for PyRecordBatchReader

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for PyRecordBatchReader

type LayoutAsBase = PyClassObject<PyRecordBatchReader>

type BaseNativeType = <PyRecordBatchReader as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<PyRecordBatchReader>

type PyClassMutability = <PyRecordBatchReader as PyClassImpl>::PyClassMutability

impl PyClassImpl for PyRecordBatchReader

const IS_BASETYPE: bool = true

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// A Python-facing Arrow record batch reader. /// /// This is a wrapper around a [RecordBatchReader].

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PyRecordBatchReader>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder PyRecordBatchReader

type Holder = Option<PyClassGuard<'a, PyRecordBatchReader>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<PyRecordBatchReader> for PyClassImplCollector<PyRecordBatchReader>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyRecordBatchReader

const NAME: &'static str = "RecordBatchReader"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for PyRecordBatchReader