Vince's CSV Parser
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
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.
 
CONSTEXPR_14 CSVFormat & column_names_policy (ColumnNamePolicy policy)
 Sets the column name lookup policy.
 
CSVFormat & chunk_size (size_t size)
 Sets the chunk size used when reading the CSV.
 
bool guess_delim () const
 

Static Public Member Functions

static CSVFormat guess_csv ()
 CSVFormat preset for delimiter inference with header/n_cols inference enabled.
 

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 44 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]sizeChunk size in bytes (minimum: CSV_CHUNK_SIZE_FLOOR)
Exceptions
std::invalid_argumentif size < CSV_CHUNK_SIZE_FLOOR

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 53 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.

◆ column_names_policy()

CONSTEXPR_14 CSVFormat & csv::CSVFormat::column_names_policy ( ColumnNamePolicy  policy)
inline

Sets the column name lookup policy.

Parameters
[in]policyUse ColumnNamePolicy::CASE_INSENSITIVE to allow case-insensitive column lookups via CSVRow::operator[] and CSVReader::index_of().

Definition at line 126 of file csv_format.hpp.

◆ delimiter() [1/2]

CSVFormat & csv::CSVFormat::delimiter ( char  delim)

Sets the delimiter of the CSV file.

Passing a single delimiter disables delimiter inference. Header-row inference still runs unless header_row()/no_header() was set explicitly or column_names() was provided.

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.

Passing multiple delimiters enables delimiter inference.

Exceptions
`std::runtime_error`thrown if trim, quote, or possible delimiting characters overlap

Definition at line 17 of file csv_format.cpp.

◆ guess_csv()

static CSVFormat csv::CSVFormat::guess_csv ( )
inlinestatic

CSVFormat preset for delimiter inference with header/n_cols inference enabled.

Definition at line 164 of file csv_format.hpp.

◆ guess_delim()

bool csv::CSVFormat::guess_delim ( ) const
inline

Definition at line 176 of file csv_format.hpp.

◆ header_row()

CSVFormat & csv::CSVFormat::header_row ( int  row)

Sets the header row.

Parameters
[in]rowRow index containing column names; negative means no header row.
Note
Unsets any values set by column_names()

Definition at line 43 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 97 of file csv_format.hpp.

◆ quote() [1/2]

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

Turn quoting on or off.

Definition at line 103 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

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 115 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 109 of file csv_format.hpp.

Member Data Documentation

◆ CSVReader

friend csv::CSVFormat::CSVReader

Definition at line 180 of file csv_format.hpp.

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