Class StringConsumer

src/core/string_consumer.hpp:27–904

* Parse data from a string / buffer. * * There are generally four operations for each data type: * - Peek: Check and return validity and value. Do not advance read position. * - TryRead: Check and return validity and value. Advance reader, if valid. * - Read: Check validity, return value or fallback-value. Advance reader, even if value is invalid, to avoid deadlocks/stalling. * - Skip: Disca

 * - Skip: Discard value. Advance reader, even if value is invalid, to avoid deadlocks/stalling.
 */
class StringConsumer {
public:
	using size_type = std::string_view::size_type;

	/**
	 * Special value for "end of data".
	 */
	static constexpr size_type npos = std::string_view::npos;

	/**
	 * ASCII whitespace characters, excluding new-line.
	 * Usable in FindChar(In|NotIn), (Peek|Read|Skip)(If|Until)Char(In|NotIn)
	 */
	static const std::string_view WHITESPACE_NO_NEWLINE;
	/**
	 * ASCII whitespace characters, including new-line.
	 * Usable in FindChar(In|NotIn), (Peek|Read|Skip)(If|Until)Char(In|NotIn)
	 */
	static const std::string_view WHITESPACE_OR_NEWLINE;

private:
	std::string_view src;
	size_type position = 0;

	static void LogError(std::string &&msg);

public:
	/**
	 * Construct parser with data from string.
	 */
	explicit StringConsumer(std::string_view src) : src(src) {}
	/**
	 * Construct parser with data from string.
	 */
	explicit StringConsumer(const std::string &src) : src(src) {}
	/**
	 * Construct parser with data from span.
	 */
	explicit StringConsumer(std::span<const char> src) : src(src.data(), src.size()) {}

	/**
	 * Check whether any bytes left to read.
	 */
	[[nodiscard]] bool AnyBytesLeft() const noexcept { return this->position < this->src.size(); }
	/**
	 * Get number of bytes left to read.
	 */
	[[nodiscard]] size_type GetBytesLeft() const noexcept { return this->src.size() - this->position; }

	/**
	 * Check whether any bytes were already read.
	 */
	[[nodiscard]] bool AnyBytesRead() const noexcept { return this->position > 0; }
	/**
	 * Get number of already read bytes.
	 */
	[[nodiscard]] size_type GetBytesRead() const noexcept { return this->position; }