Wrapper around an ArrowArray. More...

#include <qgsarrowiterator.h>

Public Member Functions
	QgsArrowArray ()=default
	Construct invalid array holder.
	QgsArrowArray (const QgsArrowArray &other)=delete
	QgsArrowArray (QgsArrowArray &&other)
	Move constructor.
	~QgsArrowArray ()
struct ArrowArray *	array ()
	Access the underlying ArrowArray from C++.
const struct ArrowArray *	array () const
	Access the underlying ArrowArray immutably from C++.
unsigned long long	cArrayAddress () const
	Returns the address of the underlying ArrowArray for import or export across boundaries.
void	exportToAddress (unsigned long long otherAddress)
	Export this array to the address of an empty ArrowArray for export across boundaries.
bool	isValid () const
	Returns `true` if this wrapper object holds a valid ArrowArray.
QgsArrowArray &	operator= (QgsArrowArray &&other)
	Move-assign constructor.
QgsArrowArray &	operator= (QgsArrowArray &other)=delete

Detailed Description

Wrapper around an ArrowArray.

This object provides a helper to allow arrays to be passed to or returned from QGIS functions in C++ or Python. See the documentation for the Arrow C Data Interface for how to interact with the underlying ArrowArray: https://arrow.apache.org/docs/format/CDataInterface.html

Since: QGIS 4.0

Definition at line 208 of file qgsarrowiterator.h.

Constructor & Destructor Documentation

◆ QgsArrowArray() [1/3]

QgsArrowArray::QgsArrowArray ( )

default

Construct invalid array holder.

◆ QgsArrowArray() [2/3]

QgsArrowArray::QgsArrowArray ( const QgsArrowArray & other )

delete

◆ QgsArrowArray() [3/3]

QgsArrowArray::QgsArrowArray ( QgsArrowArray && other )

Move constructor.

Definition at line 116 of file qgsarrowiterator.cpp.

◆ ~QgsArrowArray()

QgsArrowArray::~QgsArrowArray ( )

Definition at line 136 of file qgsarrowiterator.cpp.

Member Function Documentation

◆ array() [1/2]

struct ArrowArray * QgsArrowArray::array ( )

Access the underlying ArrowArray from C++.

Definition at line 144 of file qgsarrowiterator.cpp.

◆ array() [2/2]

const struct ArrowArray * QgsArrowArray::array ( ) const

Access the underlying ArrowArray immutably from C++.

Definition at line 149 of file qgsarrowiterator.cpp.

◆ cArrayAddress()

unsigned long long QgsArrowArray::cArrayAddress ( ) const

Returns the address of the underlying ArrowArray for import or export across boundaries.

Warning: This is intended for advanced usage and may cause a crash if used incorrectly.

Definition at line 154 of file qgsarrowiterator.cpp.

◆ exportToAddress()

void QgsArrowArray::exportToAddress ( unsigned long long otherAddress )

Export this array to the address of an empty ArrowArray for export across boundaries.

Warning: This is intended for advanced usage and may cause a crash if used incorrectly.

Definition at line 159 of file qgsarrowiterator.cpp.

◆ isValid()

bool QgsArrowArray::isValid ( ) const

Returns true if this wrapper object holds a valid ArrowArray.

Definition at line 165 of file qgsarrowiterator.cpp.

◆ operator=() [1/2]

QgsArrowArray & QgsArrowArray::operator= ( QgsArrowArray && other )

Move-assign constructor.

Definition at line 126 of file qgsarrowiterator.cpp.

◆ operator=() [2/2]

QgsArrowArray & QgsArrowArray::operator= ( QgsArrowArray & other )