arrow_array_stream.hpp File Reference

Implementation of the Arrow C Stream Interface for streaming data exchange. More...

#include "sparrow/arrow_interface/arrow_array_stream/private_data.hpp"
#include "sparrow/c_interface.hpp"
#include "sparrow/c_stream_interface.hpp"
#include "sparrow/config/config.hpp"
#include "sparrow/utils/contracts.hpp"

Include dependency graph for arrow_array_stream.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	sparrow

Functions
SPARROW_API void	sparrow::release_arrow_array_stream (ArrowArrayStream *stream)
	Release callback for ArrowArrayStream.
SPARROW_API int	sparrow::get_schema_from_arrow_array_stream (ArrowArrayStream *stream, ArrowSchema *out)
	Get schema callback for ArrowArrayStream.
SPARROW_API int	sparrow::get_next_from_arrow_array_stream (ArrowArrayStream *stream, ArrowArray *out)
	Get next array callback for ArrowArrayStream.
SPARROW_API const char *	sparrow::get_last_error_from_arrow_array_stream (ArrowArrayStream *stream)
	Get last error callback for ArrowArrayStream.
SPARROW_API void	sparrow::fill_arrow_array_stream (ArrowArrayStream &stream)

Detailed Description

Implementation of the Arrow C Stream Interface for streaming data exchange.

This file provides a complete implementation of the Arrow C Stream Interface as specified at: https://arrow.apache.org/docs/format/CStreamInterface.html

The Arrow C Stream Interface defines a standard C API for streaming Arrow data between different libraries and components within a single process. It uses a pull-based iteration model where consumers request data chunks one at a time.

Key components:

• ArrowArrayStream: C structure with callbacks for stream operations (defined in c_stream_interface.hpp)
• arrow_array_stream_proxy: C++ wrapper providing RAII and type-safe operations

See also

https://arrow.apache.org/docs/format/CStreamInterface.html

https://arrow.apache.org/docs/format/CDataInterface.html

Definition in file arrow_array_stream.hpp.