Mdt::PlainText::CsvStringParser Class Reference

CSV parser that acts on a QString as input. More...

#include <CsvStringParser.h>

Public Member Functions
	CsvStringParser ()
	Default constructor.
void	setCsvSettings (const CsvParserSettings &settings)
	Set CSV settings. More...
void	setSource (const QString &source)
	Set CSV source string. More...
bool	atEnd () const
	Check if parser is at end of the source.
Mdt::Expected< StringRecord >	readLine ()
	Read one line. More...
Mdt::Expected< StringRecordList >	readAll ()
	Read the entire CSV string. More...

Detailed Description

CSV parser that acts on a QString as input.

CsvStringParser parses a CSV string. The CSV string can contain quoted section.

Note

Some part of this API documentation refers to following standards:

• CSV-1203 available here: http://mastpoint.com/csv-1203
• RFC 4180 available here: https://tools.ietf.org/html/rfc4180

Definition at line 46 of file CsvStringParser.h.

Member Function Documentation

Expected< StringRecordList > Mdt::PlainText::CsvStringParser::readAll

(

)

Read the entire CSV string.

Precondition

CSV settings must be set before calling this function

See also

setCsvSettings()

Definition at line 60 of file CsvStringParser.cpp.

Expected< StringRecord > Mdt::PlainText::CsvStringParser::readLine

(

)

Read one line.

If a end of line is in a quoted section, it will not be threated as end of line.

This function can be used, f.ex., to store a long string to some other storage device, without having to copy the entiere source before. Reading line by line can also save some memory.

Precondition

CSV settings must be set before calling this function

See also

setCsvSettings()

Definition at line 53 of file CsvStringParser.cpp.

void Mdt::PlainText::CsvStringParser::setCsvSettings

(

const CsvParserSettings &

settings

)

Set CSV settings.

Precondition

settings must be valid

Definition at line 35 of file CsvStringParser.cpp.

void Mdt::PlainText::CsvStringParser::setSource

(

const QString &

source

)

Set CSV source string.

Note

Parsing will be done directly on source Make shure that it is not modified during parsing process (take a look at Qt documentation about STL style iterators invalidation for details)

Definition at line 42 of file CsvStringParser.cpp.

---

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

• libs/PlainText_Core/src/Mdt/PlainText/CsvStringParser.h
• libs/PlainText_Core/src/Mdt/PlainText/CsvStringParser.cpp