OpenXLSX::XLStreamReader Class Reference

#include <XLStreamReader.hpp>

Public Member Functions
	XLStreamReader ()=default
	XLStreamReader (const XLStreamReader &)=delete
XLStreamReader &	operator= (const XLStreamReader &)=delete
	XLStreamReader (XLStreamReader &&other) noexcept
XLStreamReader &	operator= (XLStreamReader &&other) noexcept
	~XLStreamReader ()
bool	hasNext ()
	Checks if there are more rows to read.
std::vector< XLCellValue >	nextRow ()
	Parses and returns the next row of data using a SAX-style state machine.
uint32_t	currentRow () const
	Returns the 1-based index of the row last read by nextRow().
void	close ()
	Closes the reader and releases resources.

Friends
class	XLWorksheet

Constructor & Destructor Documentation

XLStreamReader() [1/3]

OpenXLSX::XLStreamReader::XLStreamReader ( )

default

XLStreamReader() [2/3]

OpenXLSX::XLStreamReader::XLStreamReader ( const XLStreamReader &  )

delete

XLStreamReader() [3/3]

OpenXLSX::XLStreamReader::XLStreamReader ( XLStreamReader &&  other )

noexcept

~XLStreamReader()

OpenXLSX::XLStreamReader::~XLStreamReader

(

)

Member Function Documentation

close()

void OpenXLSX::XLStreamReader::close

(

)

Closes the reader and releases resources.

currentRow()

uint32_t OpenXLSX::XLStreamReader::currentRow

(

)

const

Returns the 1-based index of the row last read by nextRow().

Returns

The current row index.

hasNext()

bool OpenXLSX::XLStreamReader::hasNext

(

)

Checks if there are more rows to read.

Returns

true if there are more rows, false otherwise.

nextRow()

std::vector< XLCellValue > OpenXLSX::XLStreamReader::nextRow

(

)

Parses and returns the next row of data using a SAX-style state machine.

Does not allocate a DOM tree per row; instead, it scans the raw XML bytes directly. This is the key optimization for large file streaming.

Returns

A vector of XLCellValue representing the row. Empty cells are filled as XLValueType::Empty.

operator=() [1/2]

XLStreamReader & OpenXLSX::XLStreamReader::operator= ( const XLStreamReader &  )

delete

operator=() [2/2]

XLStreamReader & OpenXLSX::XLStreamReader::operator= ( XLStreamReader &&  other )

noexcept

Friends And Related Symbol Documentation

XLWorksheet

friend class XLWorksheet

friend

---

The documentation for this class was generated from the following files:

• /home/runner/work/OpenXLSX-NX/OpenXLSX-NX/OpenXLSX/headers/XLStreamReader.hpp
• /home/runner/work/OpenXLSX-NX/OpenXLSX-NX/OpenXLSX/sources/XLStreamReader.cpp