Struct PyArrayReader 

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

A Python-facing Arrow array reader.

This is a wrapper around a ArrayReader.

Implementations

impl PyArrayReader

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

Construct a new PyArrayReader from an existing ArrayReader.

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

Import from a raw Arrow C Stream capsule

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

Consume this reader and convert into a ArrayReader.

The reader can only be consumed once. Calling into_reader

pub fn into_chunked_array(self) -> PyArrowResult<PyChunkedArray>

Consume this reader and create a PyChunkedArray object

pub fn to_reader(&self) -> PyResult<Box<dyn ArrayReader + Send>>

Consume this reader and convert into a ArrayReader.

The reader can only be consumed once. Calling into_reader

pub fn to_chunked_array(&self) -> PyArrowResult<PyChunkedArray>

Consume this reader and create a PyChunkedArray object

pub fn field_ref(&self) -> PyResult<FieldRef>

Access the FieldRef of this ArrayReader.

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

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

Export this to a Python arro3.core.ArrayReader.

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

Export this to a Python nanoarrow.ArrayStream.

Trait Implementations

impl AsRef<Mutex<Option<Box<dyn ArrayReader<Item = Result<Arc<dyn Array>, ArrowError>> + Send>>>> for PyArrayReader

fn as_ref(&self) -> &Mutex<Option<Box<dyn ArrayReader + Send>>>

Converts this type into a shared reference of the (usually inferred) input type.

impl DerefToPyAny for PyArrayReader

impl Display for PyArrayReader

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

Formats the value using the given formatter.

impl ExtractPyClassWithClone for PyArrayReader

impl From<Box<dyn ArrayReader<Item = Result<Arc<dyn Array>, ArrowError>> + Send>> for PyArrayReader

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

Converts to this type from the input type.

impl From<PyArrayReader> for Arro3ArrayReader

fn from(value: PyArrayReader) -> Self

Converts to this type from the input type.

impl<'py> FromPyObject<'_, 'py> for PyArrayReader

type Error = PyErr

The type returned in the event of a conversion error.

fn extract(obj: Borrowed<'_, 'py, PyAny>) -> Result<Self, Self::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for PyArrayReader

type Target = PyArrayReader

The Python output type

type Output = Bound<'py, <PyArrayReader 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 PyArrayReader

const NAME: &str = "ArrayReader"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for PyArrayReader

type LayoutAsBase = <PyArrayReader as PyClassImpl>::Layout

type BaseNativeType = <PyArrayReader as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<PyArrayReader>

type PyClassMutability = <PyArrayReader as PyClassImpl>::PyClassMutability

type Layout<T: PyClassImpl> = <<PyArrayReader as PyClassBaseType>::BaseNativeType as PyClassBaseType>::Layout<T>

The type of object layout to use for ancestors or descendants of this type.

impl PyClassImpl for PyArrayReader

const MODULE: Option<&str>

Module which the class will be associated with.

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 array reader. /// /// This is a wrapper around a [ArrayReader].

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 Layout = <<PyArrayReader as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyArrayReader>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

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<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyMethods<PyArrayReader> for PyClassImplCollector<PyArrayReader>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyArrayReader

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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.