csv::CSVFormat Class Reference

Stores information about how to parse a CSV file. More...

#include <csv_format.hpp>

Public Member Functions
	CSVFormat ()=default
	Settings for parsing a RFC 4180 CSV file.
CSVFormat &	delimiter (char delim)
	Sets the delimiter of the CSV file.
CSVFormat &	delimiter (const std::vector< char > &delim)
	Sets a list of potential delimiters.
CSVFormat &	trim (const std::vector< char > &ws)
	Sets the whitespace characters to be trimmed.
CSVFormat &	quote (char quote)
	Sets the quote character.
CSVFormat &	column_names (const std::vector< std::string > &names)
	Sets the column names.
CSVFormat &	header_row (int row)
	Sets the header row.
CSVFormat &	no_header ()
	Tells the parser that this CSV has no header row.
CSVFormat &	quote (bool use_quote)
	Turn quoting on or off.
CONSTEXPR_14 CSVFormat &	variable_columns (VariableColumnPolicy policy=VariableColumnPolicy::IGNORE_ROW)
	Tells the parser how to handle columns of a different length than the others.
CONSTEXPR_14 CSVFormat &	variable_columns (bool policy)
	Tells the parser how to handle columns of a different length than the others.
CSVFormat &	chunk_size (size_t size)
	Sets the chunk size used when reading the CSV.
bool	guess_delim ()

Static Public Member Functions
static CSVFormat	guess_csv ()
	CSVFormat for guessing the delimiter.

Public Attributes
friend	CSVReader

Detailed Description

Stores information about how to parse a CSV file.

Can be used to construct a csv::CSVReader.

Definition at line 36 of file csv_format.hpp.

Member Function Documentation

chunk_size()

CSVFormat & csv::CSVFormat::chunk_size

(

size_t

size

)

Sets the chunk size used when reading the CSV.

Parameters

[in]

size

Chunk size in bytes (minimum: 10MB = ITERATION_CHUNK_SIZE)

Exceptions

std::invalid_argument

if size < ITERATION_CHUNK_SIZE

Use this when constructing a CSVReader from a filename and individual rows may exceed the default 10MB chunk size. The value is passed to CSVReader at construction time, before any data is read.

Definition at line 50 of file csv_format.cpp.

column_names()

CSVFormat & csv::CSVFormat::column_names

(

const std::vector< std::string > &

names

)

Sets the column names.

Note

Unsets any values set by header_row()

Definition at line 36 of file csv_format.cpp.

delimiter() [1/2]

CSVFormat & csv::CSVFormat::delimiter

(

char

delim

)

Sets the delimiter of the CSV file.

Exceptions

`std::runtime_error`

thrown if trim, quote, or possible delimiting characters overlap

Definition at line 11 of file csv_format.cpp.

delimiter() [2/2]

CSVFormat & csv::CSVFormat::delimiter

(

const std::vector< char > &

delim

)

Sets a list of potential delimiters.

Exceptions

`std::runtime_error`

thrown if trim, quote, or possible delimiting characters overlap

Parameters

[in]

delim

An array of possible delimiters to try parsing the CSV with

Definition at line 17 of file csv_format.cpp.

guess_csv()

static CSVFormat csv::CSVFormat::guess_csv ( )

inlinestatic

CSVFormat for guessing the delimiter.

Definition at line 138 of file csv_format.hpp.

guess_delim()

bool csv::CSVFormat::guess_delim ( )

inline

Definition at line 147 of file csv_format.hpp.

header_row()

CSVFormat & csv::CSVFormat::header_row

(

int

row

)

Sets the header row.

Note

Unsets any values set by column_names()

Definition at line 42 of file csv_format.cpp.

no_header()

CSVFormat & csv::CSVFormat::no_header ( )

inline

Tells the parser that this CSV has no header row.

Note

Equivalent to header_row(-1)

Definition at line 84 of file csv_format.hpp.

quote() [1/2]

CSVFormat & csv::CSVFormat::quote ( bool  use_quote )

inline

Turn quoting on or off.

Definition at line 90 of file csv_format.hpp.

quote() [2/2]

CSVFormat & csv::CSVFormat::quote

(

char

quote

)

Sets the quote character.

Exceptions

`std::runtime_error`

thrown if trim, quote, or possible delimiting characters overlap

Definition at line 23 of file csv_format.cpp.

trim()

CSVFormat & csv::CSVFormat::trim

(

const std::vector< char > &

ws

)

Sets the whitespace characters to be trimmed.

Exceptions

`std::runtime_error`

thrown if trim, quote, or possible delimiting characters overlap

Parameters

[in]

ws

An array of whitespace characters that should be trimmed

Definition at line 30 of file csv_format.cpp.

variable_columns() [1/2]

CONSTEXPR_14 CSVFormat & csv::CSVFormat::variable_columns ( bool  policy )

inline

Tells the parser how to handle columns of a different length than the others.

Definition at line 102 of file csv_format.hpp.

variable_columns() [2/2]

CONSTEXPR_14 CSVFormat & csv::CSVFormat::variable_columns ( VariableColumnPolicy  policy = VariableColumnPolicy::IGNORE_ROW )

inline

Tells the parser how to handle columns of a different length than the others.

Definition at line 96 of file csv_format.hpp.

Member Data Documentation

CSVReader

friend csv::CSVFormat::CSVReader

Definition at line 151 of file csv_format.hpp.

---

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

• include/internal/csv_format.hpp
• include/internal/csv_format.cpp