Lightweight non-owning string view over a character sequence. More...

#include <str.h>

Public Member Functions
	str_view ()=default
	Constructs an empty string view.

constexpr	str_view (const char *data, uint32_t size)
	Constructs a string view from a pointer and an explicit length.

template<size_t N>
constexpr	str_view (const char(&lit)[N])
	Constructs a string view from a literal, excluding its trailing null terminator.

GAIA_NODISCARD constexpr const char *	data () const
	Returns the underlying character pointer.

GAIA_NODISCARD constexpr uint32_t	size () const
	Returns the number of characters in the view.

GAIA_NODISCARD constexpr bool	empty () const
	Checks whether the view contains no characters.

GAIA_NODISCARD constexpr uint32_t	find (str_view value, uint32_t pos=0) const
	Finds the first occurrence of substring value starting at index pos.

GAIA_NODISCARD constexpr uint32_t	find (const char *value, uint32_t len, uint32_t pos) const
	Finds the first occurrence of a character sequence starting at index pos.

template<size_t N>
GAIA_NODISCARD constexpr uint32_t	find (const char(&lit)[N], uint32_t pos=0) const
	Finds the first occurrence of literal lit starting at index pos.

GAIA_NODISCARD constexpr uint32_t	find (char ch, uint32_t pos=0) const
	Finds the first occurrence of character ch starting at index pos.

GAIA_NODISCARD constexpr uint32_t	find_first_of (str_view chars, uint32_t pos=0) const
	Finds the first character that is present in set chars.

GAIA_NODISCARD constexpr uint32_t	find_first_of (char ch, uint32_t pos=0) const
	Finds the first occurrence of character ch.

template<size_t N>
GAIA_NODISCARD constexpr uint32_t	find_first_of (const char(&lit)[N], uint32_t pos=0) const
	Finds the first character that is present in literal set lit.

GAIA_NODISCARD constexpr uint32_t	find_last_of (str_view chars, uint32_t pos=BadIndex) const
	Finds the last character that is present in set chars.

GAIA_NODISCARD constexpr uint32_t	find_last_of (char ch, uint32_t pos=BadIndex) const
	Finds the last occurrence of character ch.

template<size_t N>
GAIA_NODISCARD constexpr uint32_t	find_last_of (const char(&lit)[N], uint32_t pos=BadIndex) const
	Finds the last character that is present in literal set lit.

GAIA_NODISCARD constexpr uint32_t	find_first_not_of (str_view chars, uint32_t pos=0) const
	Finds the first character that is NOT present in set chars.

GAIA_NODISCARD constexpr uint32_t	find_first_not_of (char ch, uint32_t pos=0) const
	Finds the first character that is different from ch.

template<size_t N>
GAIA_NODISCARD constexpr uint32_t	find_first_not_of (const char(&lit)[N], uint32_t pos=0) const
	Finds the first character that is NOT present in literal set lit.

GAIA_NODISCARD constexpr uint32_t	find_last_not_of (str_view chars, uint32_t pos=BadIndex) const
	Finds the last character that is NOT present in set chars.

GAIA_NODISCARD constexpr uint32_t	find_last_not_of (char ch, uint32_t pos=BadIndex) const
	Finds the last character that is different from ch.

template<size_t N>
GAIA_NODISCARD constexpr uint32_t	find_last_not_of (const char(&lit)[N], uint32_t pos=BadIndex) const
	Finds the last character that is NOT present in literal set lit.

template<size_t N>
GAIA_NODISCARD constexpr bool	operator== (const char(&lit)[N]) const
	Compares this view with literal lit for exact byte equality.

GAIA_NODISCARD constexpr bool	operator== (str_view other) const
	Compares this view with view other for exact byte equality.

GAIA_NODISCARD constexpr bool	operator!= (str_view other) const
	Compares this view with view other for exact byte inequality.

Public Attributes
const char *	m_data = nullptr

uint32_t	m_size = 0

Detailed Description

Lightweight non-owning string view over a character sequence.

Constructor & Destructor Documentation

◆ str_view() [1/2]

constexpr gaia::util::str_view::str_view	(	const char *	data,
		uint32_t	size
	)

inlineconstexpr

Constructs a string view from a pointer and an explicit length.

Parameters

data	Pointer to the first character. Can be nullptr if size is 0.
size	Number of characters in the view.

◆ str_view() [2/2]

template<size_t N>

constexpr gaia::util::str_view::str_view ( const char(&) lit[N] )

inlineconstexpr

Constructs a string view from a literal, excluding its trailing null terminator.

Template Parameters

N	Number of characters in the literal including the trailing null terminator.

Parameters

lit	String literal.

Member Function Documentation

◆ data()

GAIA_NODISCARD constexpr const char * gaia::util::str_view::data ( ) const

inlineconstexpr

Returns the underlying character pointer.

Returns: Pointer to the first character or nullptr for default-constructed empty views.

◆ empty()

GAIA_NODISCARD constexpr bool gaia::util::str_view::empty ( ) const

inlineconstexpr

Checks whether the view contains no characters.

Returns: True if size() == 0.

◆ find() [1/4]

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find	(	char	ch,
		uint32_t	pos = `0`
	)		const

inlineconstexpr

Finds the first occurrence of character ch starting at index pos.

Parameters

ch	Needle character.
pos	Start position in this view.

Returns: Index of first match or BadIndex.

◆ find() [2/4]

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find	(	const char *	value,
		uint32_t	len,
		uint32_t	pos
	)		const

inlineconstexpr

Finds the first occurrence of a character sequence starting at index pos.

Parameters

value	Needle pointer.
len	Number of characters in value.
pos	Start position in this view.

Returns: Index of first match or BadIndex.

◆ find() [3/4]

template<size_t N>

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find	(	const char(&)	lit[N],
		uint32_t	pos = `0`
	)		const

inlineconstexpr

Finds the first occurrence of literal lit starting at index pos.

Template Parameters

N	Number of characters in the literal including the trailing null terminator.

Parameters

lit	Needle literal.
pos	Start position in this view.

Returns: Index of first match or BadIndex.

◆ find() [4/4]

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find	(	str_view	value,
		uint32_t	pos = `0`
	)		const

inlineconstexpr

Finds the first occurrence of substring value starting at index pos.

Parameters

value	Needle string view.
pos	Start position in this view.

Returns: Index of first match or BadIndex.

◆ find_first_not_of() [1/3]

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_first_not_of	(	char	ch,
		uint32_t	pos = `0`
	)		const

inlineconstexpr

Finds the first character that is different from ch.

Parameters

ch	Excluded character.
pos	Start position in this view.

Returns: Index of first non-matching character or BadIndex.

◆ find_first_not_of() [2/3]

template<size_t N>

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_first_not_of	(	const char(&)	lit[N],
		uint32_t	pos = `0`
	)		const

inlineconstexpr

Finds the first character that is NOT present in literal set lit.

Template Parameters

N	Number of characters in the literal including the trailing null terminator.

Parameters

lit	Set literal.
pos	Start position in this view.

Returns: Index of first non-matching character or BadIndex.

◆ find_first_not_of() [3/3]

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_first_not_of	(	str_view	chars,
		uint32_t	pos = `0`
	)		const

inlineconstexpr

Finds the first character that is NOT present in set chars.

Parameters

chars	Set of excluded characters.
pos	Start position in this view.

Returns: Index of first non-matching character or BadIndex.

◆ find_first_of() [1/3]

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_first_of	(	char	ch,
		uint32_t	pos = `0`
	)		const

inlineconstexpr

Finds the first occurrence of character ch.

Parameters

ch	Needle character.
pos	Start position in this view.

Returns: Index of first match or BadIndex.

◆ find_first_of() [2/3]

template<size_t N>

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_first_of	(	const char(&)	lit[N],
		uint32_t	pos = `0`
	)		const

inlineconstexpr

Finds the first character that is present in literal set lit.

Template Parameters

N	Number of characters in the literal including the trailing null terminator.

Parameters

lit	Set literal.
pos	Start position in this view.

Returns: Index of first matching character or BadIndex.

◆ find_first_of() [3/3]

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_first_of	(	str_view	chars,
		uint32_t	pos = `0`
	)		const

inlineconstexpr

Finds the first character that is present in set chars.

Parameters

chars	Set of accepted characters.
pos	Start position in this view.

Returns: Index of first matching character or BadIndex.

◆ find_last_not_of() [1/3]

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_last_not_of	(	char	ch,
		uint32_t	pos = `BadIndex`
	)		const

inlineconstexpr

Finds the last character that is different from ch.

Parameters

ch	Excluded character.
pos	Maximum position to consider, BadIndex means end of view.

Returns: Index of last non-matching character or BadIndex.

◆ find_last_not_of() [2/3]

template<size_t N>

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_last_not_of	(	const char(&)	lit[N],
		uint32_t	pos = `BadIndex`
	)		const

inlineconstexpr

Finds the last character that is NOT present in literal set lit.

Template Parameters

N	Number of characters in the literal including the trailing null terminator.

Parameters

lit	Set literal.
pos	Maximum position to consider, BadIndex means end of view.

Returns: Index of last non-matching character or BadIndex.

◆ find_last_not_of() [3/3]

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_last_not_of	(	str_view	chars,
		uint32_t	pos = `BadIndex`
	)		const

inlineconstexpr

Finds the last character that is NOT present in set chars.

Parameters

chars	Set of excluded characters.
pos	Maximum position to consider, BadIndex means end of view.

Returns: Index of last non-matching character or BadIndex.

◆ find_last_of() [1/3]

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_last_of	(	char	ch,
		uint32_t	pos = `BadIndex`
	)		const

inlineconstexpr

Finds the last occurrence of character ch.

Parameters

ch	Needle character.
pos	Maximum position to consider, BadIndex means end of view.

Returns: Index of last match or BadIndex.

◆ find_last_of() [2/3]

template<size_t N>

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_last_of	(	const char(&)	lit[N],
		uint32_t	pos = `BadIndex`
	)		const

inlineconstexpr

Finds the last character that is present in literal set lit.

Template Parameters

N	Number of characters in the literal including the trailing null terminator.

Parameters

lit	Set literal.
pos	Maximum position to consider, BadIndex means end of view.

Returns: Index of last matching character or BadIndex.

◆ find_last_of() [3/3]

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::find_last_of	(	str_view	chars,
		uint32_t	pos = `BadIndex`
	)		const

inlineconstexpr

Finds the last character that is present in set chars.

Parameters

chars	Set of accepted characters.
pos	Maximum position to consider, BadIndex means end of view.

Returns: Index of last matching character or BadIndex.

◆ operator!=()

GAIA_NODISCARD constexpr bool gaia::util::str_view::operator!= ( str_view other ) const

inlineconstexpr

Compares this view with view other for exact byte inequality.

Parameters

other View to compare with.

Returns: True when lengths or contents differ.

◆ operator==() [1/2]

template<size_t N>

GAIA_NODISCARD constexpr bool gaia::util::str_view::operator== ( const char(&) lit[N] ) const

inlineconstexpr

Compares this view with literal lit for exact byte equality.

Template Parameters

N	Number of characters in the literal including the trailing null terminator.

Parameters

lit	Literal to compare with.

Returns: True when lengths and contents are equal.

◆ operator==() [2/2]

GAIA_NODISCARD constexpr bool gaia::util::str_view::operator== ( str_view other ) const

inlineconstexpr

Compares this view with view other for exact byte equality.

Parameters

other View to compare with.

Returns: True when lengths and contents are equal.

◆ size()

GAIA_NODISCARD constexpr uint32_t gaia::util::str_view::size ( ) const

inlineconstexpr

Returns the number of characters in the view.

Returns: Character count.

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

/home/runner/work/gaia-ecs/gaia-ecs/include/gaia/util/str.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ str_view() [1/2]

◆ str_view() [2/2]

Member Function Documentation

◆ data()

◆ empty()

◆ find() [1/4]

◆ find() [2/4]

◆ find() [3/4]

◆ find() [4/4]

◆ find_first_not_of() [1/3]

◆ find_first_not_of() [2/3]

◆ find_first_not_of() [3/3]

◆ find_first_of() [1/3]

◆ find_first_of() [2/3]

◆ find_first_of() [3/3]

◆ find_last_not_of() [1/3]

◆ find_last_not_of() [2/3]

◆ find_last_not_of() [3/3]

◆ find_last_of() [1/3]

◆ find_last_of() [2/3]

◆ find_last_of() [3/3]

◆ operator!=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ size()