Struct PyGeoArrayReader 

pub struct PyGeoArrayReader { /* private fields */ }

Python wrapper for a GeoArrow array reader (stream).

This type represents a stream of GeoArrow arrays that can be read incrementally. It implements the Arrow C Stream Interface, allowing zero-copy data exchange with Arrow-compatible Python libraries.

The reader can be iterated over to yield individual PyGeoArray chunks, or materialized into a PyGeoChunkedArray using the into_chunked_array() method. For stream processing, prefer into_reader().

Implementations

impl PyGeoArrayReader

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

Create a new PyGeoArrayReader from a GeoArrow array reader.

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

Import from a raw Arrow C Stream capsule

pub fn data_type(&self) -> &GeoArrowType

Get the GeoArrow data type of arrays in this stream.

pub fn into_reader(self) -> PyResult<Box<dyn GeoArrowArrayReader + 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) -> PyGeoArrowResult<PyGeoChunkedArray>

Consume this reader and create a PyGeoChunkedArray object

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

Export to a geoarrow.rust.core.GeoArrowArrayReader.

This requires that you depend on geoarrow-rust-core from your Python package.

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

Export to a geoarrow.rust.core.GeoArrowArrayReader.

This requires that you depend on geoarrow-rust-core from your Python package.

Trait Implementations

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

type Error = PyErr

The type returned in the event of a conversion error.

fn extract(ob: Borrowed<'_, 'py, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for PyGeoArrayReader

type Target = PyGeoArrayReader

The Python output type

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

const NAME: &str = "GeoArrayReader"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for PyGeoArrayReader

type LayoutAsBase = <PyGeoArrayReader as PyClassImpl>::Layout

type BaseNativeType = <PyGeoArrayReader as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<PyGeoArrayReader>

type PyClassMutability = <PyGeoArrayReader as PyClassImpl>::PyClassMutability

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

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

impl PyClassImpl for PyGeoArrayReader

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 = /// Python wrapper for a GeoArrow array reader (stream). /// /// This type represents a stream of GeoArrow arrays that can be read incrementally. It implements /// the Arrow C Stream Interface, allowing zero-copy data exchange with Arrow-compatible Python /// libraries. /// /// The reader can be iterated over to yield individual [`PyGeoArray`] chunks, or materialized /// into a [`PyGeoChunkedArray`] using the [`into_chunked_array()`][Self::into_chunked_array] /// method. For stream processing, prefer [`into_reader()`][Self::into_reader].

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

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<PyGeoArrayReader> for PyClassImplCollector<PyGeoArrayReader>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyGeoArrayReader

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.

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

type Error = PyGeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: Box<dyn ArrayReader + Send>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PyArrayReader> for PyGeoArrayReader

type Error = PyGeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: PyArrayReader) -> Result<Self, Self::Error>

Performs the conversion.

impl DerefToPyAny for PyGeoArrayReader

impl ExtractPyClassWithClone for PyGeoArrayReader