Data type representing individual CSV values. More...

#include <csv_row.hpp>

Public Member Functions
constexpr	CSVField (csv::string_view _sv) noexcept
	Constructs a CSVField from a string_view.

	operator std::string () const

template<typename T = std::string>
T	get ()
	Returns the value casted to the requested type, performing type checking before.

template<typename T = std::string>
bool	try_get (T &out) noexcept
	Attempts to retrieve the value as the requested type without throwing exceptions.

template<typename T = long long>
bool	try_parse_hex (T &parsedValue)
	Parse a hexadecimal value, returning false if the value is not hex.

bool	try_parse_decimal (long double &dVal, const char decimalSymbol='.')
	Attempts to parse a decimal (or integer) value using the given symbol, returning `true` if the value is numeric.

template<typename T >
CONSTEXPR_14 bool	operator== (T other) const noexcept
	Compares the contents of this field to a numeric value.

CONSTEXPR csv::string_view	get_sv () const noexcept
	Return a string view over the field's contents.

CONSTEXPR_14 bool	is_null () noexcept
	Returns true if field is an empty string or string of whitespace characters.

CONSTEXPR_14 bool	is_str () noexcept
	Returns true if field is a non-numeric, non-empty string.

CONSTEXPR_14 bool	is_num () noexcept
	Returns true if field is an integer or float.

CONSTEXPR_14 bool	is_int () noexcept
	Returns true if field is an integer.

CONSTEXPR_14 bool	is_float () noexcept
	Returns true if field is a floating point value.

CONSTEXPR_14 DataType	type () noexcept
	Return the type of the underlying CSV data.

template<>
CONSTEXPR_14 long double	get ()
	Retrieve this field's value as a long double.

template<>
CONSTEXPR_14 bool	try_get (long double &out) noexcept
	Non-throwing retrieval of field as long double.

template<>
CONSTEXPR bool	operator== (const char *other) const noexcept
	Compares the contents of this field to a string.

template<>
CONSTEXPR bool	operator== (csv::string_view other) const noexcept
	Compares the contents of this field to a string.

Detailed Description

Data type representing individual CSV values.

CSVFields can be obtained by using CSVRow::operator[]

Definition at line 39 of file csv_row.hpp.

Constructor & Destructor Documentation

◆ CSVField()

constexpr csv::CSVField::CSVField ( csv::string_view _sv )

inlineexplicitconstexprnoexcept

Constructs a CSVField from a string_view.

Definition at line 42 of file csv_row.hpp.

Member Function Documentation

◆ get() [1/2]

template<typename T = std::string>

T csv::CSVField::get ( )

inline

Returns the value casted to the requested type, performing type checking before.

Valid options for T

std::string or csv::string_view
signed integral types (signed char, short, int, long int, long long int)
floating point types (float, double, long double)
unsigned integers are not supported at this time, but may be in a later release

Invalid conversions

Converting non-numeric values to any numeric type
Converting floating point values to integers
Converting a large integer to a smaller type that will not hold it

Note: This method is capable of parsing scientific E-notation. See this page for more details.

Exceptions

std::runtime_error Thrown if an invalid conversion is performed.

Warning: Currently, conversions to floating point types are not checked for loss of precision; Any string_views returned are only guaranteed to be valid if the parent CSVRow is still alive. If you are concerned about object lifetimes, then grab a std::string or a numeric value.

Definition at line 76 of file csv_row.hpp.

◆ get() [2/2]

template<>

CONSTEXPR_14 long double csv::CSVField::get ( )

Retrieve this field's value as a long double.

Definition at line 471 of file csv_row.hpp.

◆ get_sv()

CONSTEXPR csv::string_view csv::CSVField::get_sv ( ) const

inlinenoexcept

Return a string view over the field's contents.

Definition at line 240 of file csv_row.hpp.

◆ is_float()

CONSTEXPR_14 bool csv::CSVField::is_float ( )

inlinenoexcept

Returns true if field is a floating point value.

Definition at line 257 of file csv_row.hpp.

◆ is_int()

CONSTEXPR_14 bool csv::CSVField::is_int ( )

inlinenoexcept

Returns true if field is an integer.

Definition at line 252 of file csv_row.hpp.

◆ is_null()

CONSTEXPR_14 bool csv::CSVField::is_null ( )

inlinenoexcept

Returns true if field is an empty string or string of whitespace characters.

Definition at line 243 of file csv_row.hpp.

◆ is_num()

CONSTEXPR_14 bool csv::CSVField::is_num ( )

inlinenoexcept

Returns true if field is an integer or float.

Definition at line 249 of file csv_row.hpp.

◆ is_str()

CONSTEXPR_14 bool csv::CSVField::is_str ( )

inlinenoexcept

Returns true if field is a non-numeric, non-empty string.

Definition at line 246 of file csv_row.hpp.

◆ operator std::string()

csv::CSVField::operator std::string ( ) const

inline

Definition at line 44 of file csv_row.hpp.

◆ operator==() [1/3]

template<>

CONSTEXPR bool csv::CSVField::operator== ( const char * other ) const

noexcept

Compares the contents of this field to a string.

Definition at line 507 of file csv_row.hpp.

◆ operator==() [2/3]

template<>

CONSTEXPR bool csv::CSVField::operator== ( csv::string_view other ) const

noexcept

Compares the contents of this field to a string.

Definition at line 514 of file csv_row.hpp.

◆ operator==() [3/3]

template<typename T >

CONSTEXPR_14 bool csv::CSVField::operator== ( T other ) const

inlinenoexcept

Compares the contents of this field to a numeric value.

If this field does not contain a numeric value, then all comparisons return false.

Note: Floating point values are considered equal if they are within 0.000001 of each other.

Warning: Multiple numeric comparisons involving the same field can be done more efficiently by calling the CSVField::get<>() method.

See also: csv::CSVField::operator==(const char * other); csv::CSVField::operator==(csv::string_view other)

Definition at line 218 of file csv_row.hpp.

◆ try_get() [1/2]

template<>

CONSTEXPR_14 bool csv::CSVField::try_get ( long double & out )

noexcept

Non-throwing retrieval of field as long double.

Definition at line 494 of file csv_row.hpp.

◆ try_get() [2/2]

template<typename T = std::string>

bool csv::CSVField::try_get ( T & out )

inlinenoexcept

Attempts to retrieve the value as the requested type without throwing exceptions.

Parameters

[out] out Output parameter that receives the converted value if successful

Returns: true if conversion succeeded, false otherwise

Valid options for T

std::string or csv::string_view
signed integral types (signed char, short, int, long int, long long int)
floating point types (float, double, long double)
unsigned integers are not supported at this time, but may be in a later release

When conversion fails (returns false)

Converting non-numeric values to any numeric type
Converting floating point values to integers
Converting a large integer to a smaller type that will not hold it
Converting negative values to unsigned types

Note: This method is capable of parsing scientific E-notation.

Warning: Currently, conversions to floating point types are not checked for loss of precision; Any string_views returned are only guaranteed to be valid if the parent CSVRow is still alive.

Example:

int value;
if (field.try_get(value)) {
    // Use value safely
} else {
    // Handle conversion failure
}

Definition at line 149 of file csv_row.hpp.

◆ try_parse_decimal()

bool csv::CSVField::try_parse_decimal	(	long double &	dVal,
		const char	decimalSymbol = `'.'`
	)

Attempts to parse a decimal (or integer) value using the given symbol, returning true if the value is numeric.

Note: This method also updates this field's type

Definition at line 91 of file csv_row.cpp.

◆ try_parse_hex()

template<typename T = long long>

bool csv::CSVField::try_parse_hex ( T & parsedValue )

inline

Parse a hexadecimal value, returning false if the value is not hex.

Template Parameters

T	An integral type (int, long, long long, etc.)

Definition at line 190 of file csv_row.hpp.

◆ type()

CONSTEXPR_14 DataType csv::CSVField::type ( )

inlinenoexcept

Return the type of the underlying CSV data.

Definition at line 260 of file csv_row.hpp.

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

include/internal/csv_row.hpp
include/internal/csv_row.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CSVField()

Member Function Documentation

◆ get() [1/2]

◆ get() [2/2]

◆ get_sv()

◆ is_float()

◆ is_int()

◆ is_null()

◆ is_num()

◆ is_str()

◆ operator std::string()

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ try_get() [1/2]

◆ try_get() [2/2]

◆ try_parse_decimal()

◆ try_parse_hex()

◆ type()