rav::StringParser Class Reference

A handy utility class for parsing strings. More...

#include <string_parser.hpp>

Public Member Functions
	StringParser (const std::string_view str)
	Constructs a parser from given string view.
	StringParser (const std::optional< std::string_view > &str)
	Constructs a parser from given string view.
	StringParser (const char *str, const size_t size)
	Constructs a parser from given c-string and size.
	StringParser (const char *str)
	Constructs a parser from given c-string.
	StringParser (const std::string &str)
	Constructs a parser from given string.
std::optional< std::string_view >	read_until (const char delimiter, const bool include_delimiter=false)
	Reads until given delimiter.
std::optional< std::string_view >	read_until (const char *delimiter, const bool include_delimiter=false)
	Reads until given delimiter.
std::optional< std::string_view >	split (const char delimiter, const bool include_delimiter=false)
	Reads until the given delimiter or until the end of the string.
std::optional< std::string_view >	split (const char *delimiter, const bool include_delimiter=false)
	Reads until given delimiter or until the end of the string.
std::optional< std::string_view >	read_line ()
	Reads a line from the string.
std::optional< std::string_view >	read_until_newline ()
	Reads until a newline is found.
std::optional< std::string_view >	read_until_end ()
	Reads the rest of the string.
template<class T>
std::optional< T >	read_int ()
	Tries to read an integer from the string.
std::optional< float >	read_float ()
	Tries to read a float from the string.
std::optional< double >	read_double ()
	Tries to read a float from the string.
bool	skip (const char *chars)
	Skips the given sequence of characters from the beginning of the string.
bool	skip (const char chr)
	Skips the given character from the beginning of the string.
uint64_t	skip_n (const char chr, const size_t count)
	Skips n amount of characters from the beginning of the string.
bool	exhausted () const
size_t	size () const
bool	empty () const

Static Public Attributes
static constexpr auto	k_max_leading_spaces = 100'000

Detailed Description

A handy utility class for parsing strings.

It works like a stream, where it maintains a position in the string and subsequent calls will read from that position.

Definition at line 42 of file string_parser.hpp.

Constructor & Destructor Documentation

StringParser() [1/5]

rav::StringParser::StringParser ( const std::string_view str )

inlineexplicit

Constructs a parser from given string view.

Doesn't take ownership of the string, so make sure for the original string to outlive this parser instance.

Parameters

str	The string to parse.

Definition at line 51 of file string_parser.hpp.

StringParser() [2/5]

rav::StringParser::StringParser ( const std::optional< std::string_view > & str )

inlineexplicit

Constructs a parser from given string view.

Doesn't take ownership of the string, so make sure for the original string to outlive this parser instance.

Parameters

str	The string to parse.

Definition at line 58 of file string_parser.hpp.

StringParser() [3/5]

rav::StringParser::StringParser ( const char * str, const size_t size )

inline

Constructs a parser from given c-string and size.

Doesn't take ownership of the string, so make sure for the original string to outlive this parser instance.

Parameters

str	The string to parse.
size	The size of the string (without terminating null character).

Definition at line 70 of file string_parser.hpp.

StringParser() [4/5]

rav::StringParser::StringParser ( const char * str )

inlineexplicit

Constructs a parser from given c-string.

String must be null-terminated. Doesn't take ownership of the string, so make sure for the original string to outlive this parser instance.

Parameters

str	The string to parse.

Definition at line 77 of file string_parser.hpp.

StringParser() [5/5]

rav::StringParser::StringParser ( const std::string & str )

inlineexplicit

Constructs a parser from given string.

Doesn't take ownership of the string, so make sure for the original string to outlive this parser instance.

Parameters

str	The string to parse.

Definition at line 84 of file string_parser.hpp.

Member Function Documentation

empty()

bool rav::StringParser::empty ( ) const

inlinenodiscard

Returns

True if the parser is empty, or false if the parser points to some data.

Definition at line 355 of file string_parser.hpp.

exhausted()

bool rav::StringParser::exhausted ( ) const

inlinenodiscard

Returns

True if the string is exhausted, or false otherwise.

Definition at line 341 of file string_parser.hpp.

read_double()

std::optional< double > rav::StringParser::read_double ( )

inline

Tries to read a float from the string.

If successful, the float is returned, otherwise an empty optional is returned.

Returns

The read float or an empty optional.

Definition at line 277 of file string_parser.hpp.

read_float()

std::optional< float > rav::StringParser::read_float ( )

inline

Tries to read a float from the string.

If successful, the float is returned, otherwise an empty optional is returned.

Returns

The read float or an empty optional.

Definition at line 256 of file string_parser.hpp.

read_int()

template<class T>

std::optional< T > rav::StringParser::read_int ( )

inline

Tries to read an integer from the string.

If successful, the integer is returned; otherwise an empty optional is returned. Leading whitespace characters are automatically ignored when parsing the number

Template Parameters

T	The type of the integer to read.

Returns

The read integer or an empty optional.

Definition at line 238 of file string_parser.hpp.

read_line()

std::optional< std::string_view > rav::StringParser::read_line ( )

inline

Reads a line from the string.

A line is considered to be terminated by a newline character or by the end of the string.

Returns

The read line.

Definition at line 181 of file string_parser.hpp.

read_until() [1/2]

std::optional< std::string_view > rav::StringParser::read_until ( const char * delimiter, const bool include_delimiter = false )

inline

Reads until given delimiter.

Parameters

delimiter	The character sequence to read until.
include_delimiter	Whether to include the delimiter in the returned string.

Returns

The string until delimited, or a nullopt if the delimiter was not found.

Definition at line 113 of file string_parser.hpp.

read_until() [2/2]

std::optional< std::string_view > rav::StringParser::read_until ( const char delimiter, const bool include_delimiter = false )

inline

Reads until given delimiter.

Parameters

delimiter	The character sequence to read until.
include_delimiter	Whether to include the delimiter in the returned string.

Returns

The string until delimited, or a nullopt if the delimiter was not found.

Definition at line 92 of file string_parser.hpp.

read_until_end()

std::optional< std::string_view > rav::StringParser::read_until_end ( )

inline

Reads the rest of the string.

Returns

The read string.

Definition at line 222 of file string_parser.hpp.

read_until_newline()

std::optional< std::string_view > rav::StringParser::read_until_newline ( )

inline

Reads until a newline is found.

Newline can be \r
or
.

Returns

The line until newline, or std::nullopt if no newline was found.

Definition at line 200 of file string_parser.hpp.

size()

size_t rav::StringParser::size ( ) const

inlinenodiscard

Returns

The remaining size this parser is pointing at.

Definition at line 348 of file string_parser.hpp.

skip() [1/2]

bool rav::StringParser::skip ( const char * chars )

inline

Skips the given sequence of characters from the beginning of the string.

Parameters

chars

The characters to skip.

Returns

True if the sequence was skipped, or false otherwise.

Definition at line 298 of file string_parser.hpp.

skip() [2/2]

bool rav::StringParser::skip ( const char chr )

inline

Skips the given character from the beginning of the string.

Parameters

chr	The character to skip.

Returns

True if the sequence was skipped, or false otherwise.

Definition at line 312 of file string_parser.hpp.

skip_n()

uint64_t rav::StringParser::skip_n ( const char chr, const size_t count )

inline

Skips n amount of characters from the beginning of the string.

Parameters

chr	The character to skip.
count	The number of characters to skip.

Returns

The number of characters skipped.

Definition at line 327 of file string_parser.hpp.

split() [1/2]

std::optional< std::string_view > rav::StringParser::split ( const char * delimiter, const bool include_delimiter = false )

inline

Reads until given delimiter or until the end of the string.

It's like splitting string, but only returning the first part.

Parameters

delimiter	The character sequence to read until.
include_delimiter	Whether to include the delimiter in the returned string.

Returns

The read string, or an empty optional if the string is exhausted.

Definition at line 159 of file string_parser.hpp.

split() [2/2]

std::optional< std::string_view > rav::StringParser::split ( const char delimiter, const bool include_delimiter = false )

inline

Reads until the given delimiter or until the end of the string.

It's like splitting string but only returning (and consuming) the first part.

Parameters

delimiter	The character sequence to read until.
include_delimiter	Whether to include the delimiter in the returned string.

Returns

The read string, or an empty optional if the string is exhausted.

Definition at line 135 of file string_parser.hpp.

Member Data Documentation

k_max_leading_spaces

auto rav::StringParser::k_max_leading_spaces = 100'000

staticconstexpr

Definition at line 44 of file string_parser.hpp.

---

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

• string_parser.hpp