Struct PyChunkedArray 

pub struct PyChunkedArray { /* private fields */ }

A Python-facing Arrow chunked array.

This is a wrapper around a FieldRef and a Vec of ArrayRef.

Implementations

impl PyChunkedArray

pub fn try_new(chunks: Vec<ArrayRef>, field: FieldRef) -> PyResult<Self>

Construct a new PyChunkedArray from existing chunks and a field.

pub fn data_type(&self) -> &DataType

Access the DataType of this ChunkedArray

pub fn from_array_refs(chunks: Vec<ArrayRef>) -> PyArrowResult<Self>

Create a new PyChunkedArray from a vec of ArrayRefs, inferring their data type automatically.

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

Import from a raw Arrow C Stream capsule

pub fn chunks(&self) -> &[ArrayRef]

Access the underlying chunks.

pub fn field(&self) -> &FieldRef

Access the underlying field.

pub fn into_inner(self) -> (Vec<ArrayRef>, FieldRef)

Consume this and return its inner parts.

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

Export this to a Python arro3.core.ChunkedArray.

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

Export this to a Python arro3.core.ChunkedArray.

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

Requires pyarrow >=14

Trait Implementations

impl AsRef<[Arc<dyn Array>]> for PyChunkedArray

fn as_ref(&self) -> &[ArrayRef]

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

impl Debug for PyChunkedArray

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

Formats the value using the given formatter.

impl Display for PyChunkedArray

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

Formats the value using the given formatter.

impl From<PyChunkedArray> for Arro3ChunkedArray

fn from(value: PyChunkedArray) -> Self

Converts to this type from the input type.

impl<'a> FromPyObject<'_, 'a> for PyChunkedArray

type Error = PyErr

The type returned in the event of a conversion error.

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

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for PyChunkedArray

type Target = PyChunkedArray

The Python output type

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

const NAME: &str = "ChunkedArray"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for PyChunkedArray

type LayoutAsBase = <PyChunkedArray as PyClassImpl>::Layout

type BaseNativeType = <PyChunkedArray as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<PyChunkedArray>

type PyClassMutability = <PyChunkedArray as PyClassImpl>::PyClassMutability

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

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

impl PyClassImpl for PyChunkedArray

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 chunked array. /// /// This is a wrapper around a [FieldRef] and a `Vec` of [ArrayRef].

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

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 PyClassNewTextSignature for PyChunkedArray

const TEXT_SIGNATURE: &'static str = "(arrays, type=None)"

impl PyClass__eq__SlotFragment<PyChunkedArray> for PyClassImplCollector<PyChunkedArray>

unsafe fn __eq__( self, py: Python<'_>, _slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyMethods<PyChunkedArray> for PyClassImplCollector<PyChunkedArray>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyChunkedArray

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<Vec<Arc<dyn Array>>> for PyChunkedArray

type Error = PyArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl DerefToPyAny for PyChunkedArray

impl ExtractPyClassWithClone for PyChunkedArray