Wrapper around an ArrowArrayStream. More...

#include <qgsarrowiterator.h>

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

Detailed Description

Wrapper around an ArrowArrayStream.

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

Since: QGIS 4.0

Definition at line 271 of file qgsarrowiterator.h.

Constructor & Destructor Documentation

◆ QgsArrowArrayStream() [1/3]

QgsArrowArrayStream::QgsArrowArrayStream ( )

default

Construct invalid array stream holder.

◆ QgsArrowArrayStream() [2/3]

QgsArrowArrayStream::QgsArrowArrayStream ( const QgsArrowArrayStream & other )

delete

◆ QgsArrowArrayStream() [3/3]

QgsArrowArrayStream::QgsArrowArrayStream ( QgsArrowArrayStream && other )

Move constructor.

Definition at line 182 of file qgsarrowiterator.cpp.

◆ ~QgsArrowArrayStream()

QgsArrowArrayStream::~QgsArrowArrayStream ( )

Definition at line 202 of file qgsarrowiterator.cpp.

Member Function Documentation

◆ arrayStream()

struct ArrowArrayStream * QgsArrowArrayStream::arrayStream ( )

Access the underlying ArrowArray from C++.

Definition at line 210 of file qgsarrowiterator.cpp.

◆ cArrayStreamAddress()

unsigned long long QgsArrowArrayStream::cArrayStreamAddress ( ) const

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

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

Definition at line 215 of file qgsarrowiterator.cpp.

◆ exportToAddress()

void QgsArrowArrayStream::exportToAddress ( unsigned long long otherAddress )

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

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

Definition at line 224 of file qgsarrowiterator.cpp.

◆ isValid()

bool QgsArrowArrayStream::isValid ( ) const

Returns true if this wrapper object holds a valid ArrowArray.

Definition at line 232 of file qgsarrowiterator.cpp.

◆ operator=() [1/2]

QgsArrowArrayStream & QgsArrowArrayStream::operator= ( QgsArrowArrayStream && other )

Move-assign constructor.

Definition at line 192 of file qgsarrowiterator.cpp.

◆ operator=() [2/2]

QgsArrowArrayStream & QgsArrowArrayStream::operator= ( QgsArrowArrayStream & other )