xentara::utils::tparam::String< kSize > Struct Template Reference

A string literal of type char More...

#include <xentara/utils/tparam/String_String.hpp>

Inheritance diagram for xentara::utils::tparam::String< kSize >:

Additional Inherited Members
Public Types inherited from xentara::utils::tparam::BasicString< char, kSize >
using	traits_type = std::char_traits< Char >
	The character traits.
using	value_type = Char
	The character type.
using	size_type = std::size_t
	The type used for sizes.
using	difference_type = std::ptrdiff_t
	The type used for distances.
using	reference = value_type &
	A reference to an character.
using	const_reference = const value_type &
	A const reference to an character.
using	pointer = value_type *
	A pointer to an character.
using	const_pointer = const value_type *
	A const pointer to an character.
using	iterator = core::ContiguousIterator< pointer, BasicString >
	An iterator.
using	const_iterator = core::ContiguousIterator< const_pointer, BasicString >
	A const iterator.
using	reverse_iterator = std::reverse_iterator< iterator >
	An iterator for iterating in reverse order.
using	const_reverse_iterator = std::reverse_iterator< const_iterator >
	A const iterator for iterating in reverse order.
Public Member Functions inherited from xentara::utils::tparam::BasicString< char, kSize >
constexpr	BasicString (const Char(&string)[kSize+1]) noexcept
	Constructor that sets the string.
constexpr	operator std::basic_string_view< Char, traits_type > () const noexcept
	conversion to a string view
constexpr	operator std::basic_string< Char, traits_type, Allocator > () const noexcept
	conversion to an std::string
constexpr auto	view () const noexcept -> std::basic_string_view< Char, traits_type >
	Gets the data as a string view.
constexpr auto	str (const Allocator &allocator=Allocator()) const noexcept -> std::basic_string< Char, traits_type, Allocator >
	Gets the data as an std::string.
constexpr auto	at (size_type index) const -> const_reference
	Accesses the character at a certain index.
constexpr auto	at (size_type index) -> reference
	Accesses the character at a certain index.
constexpr auto	operator[] (size_type index) const noexcept -> const_reference
	Subscript operator.
constexpr auto	operator[] (size_type index) noexcept -> reference
	Subscript operator.
constexpr auto	front () const noexcept -> const_reference
	Returns the first character.
constexpr auto	front () noexcept -> reference
	Returns the first character.
constexpr auto	back () const noexcept -> const_reference
	Returns the last character.
constexpr auto	back () noexcept -> reference
	Returns the last character.
constexpr auto	data () const noexcept -> const Char *
	Gets a pointer to the data.
constexpr auto	data () noexcept -> Char *
	Gets a pointer to the data.
constexpr auto	c_str () const noexcept -> const Char *
	Gets the data as a null terminated string.
constexpr auto	begin () noexcept -> iterator
	Creates a begin iterator.
constexpr auto	begin () const noexcept -> const_iterator
	Creates a begin iterator.
constexpr auto	cbegin () const noexcept -> const_iterator
	Creates a begin iterator.
constexpr auto	end () noexcept -> iterator
	Creates an end iterator.
constexpr auto	end () const noexcept -> const_iterator
	Creates an end iterator.
constexpr auto	cend () const noexcept -> const_iterator
	Creates an end iterator.
constexpr auto	rbegin () noexcept -> reverse_iterator
	Creates a reverse begin iterator.
constexpr auto	rbegin () const noexcept -> const_reverse_iterator
	Creates a reverse begin iterator.
constexpr auto	crbegin () const noexcept -> const_reverse_iterator
	Creates a reverse begin iterator.
constexpr auto	rend () noexcept -> reverse_iterator
	Creates a reverse end iterator.
constexpr auto	rend () const noexcept -> const_reverse_iterator
	Creates a reverse end iterator.
constexpr auto	crend () const noexcept -> const_reverse_iterator
	Creates a reverse end iterator.
constexpr auto	empty () const noexcept -> bool
	Determines whether the string is empty.
constexpr auto	size () const noexcept -> std::size_t
	Gets the size.
constexpr auto	length () const noexcept -> std::size_t
	Alias for size()
constexpr auto	starts_with (std::basic_string_view< Char > string) const noexcept -> bool
	Checks whether the string starts with a certain text.
constexpr auto	starts_with (Char character) const noexcept -> bool
	Checks whether the string starts with a certain character.
constexpr auto	starts_with (const Char *string) const -> bool
	Checks whether the string starts with a certain text.
constexpr auto	ends_with (std::basic_string_view< Char > string) const noexcept -> bool
	Checks whether the string ends with a certain text.
constexpr auto	ends_with (Char character) const noexcept -> bool
	Checks whether the string ends with a certain character.
constexpr auto	ends_with (const Char *string) const -> bool
	Checks whether the string ends with a certain text.

Detailed Description

template<std::size_t kSize>
struct xentara::utils::tparam::String< kSize >

A string literal of type char

Note

This is a derived type rather than a type alias. This is necessary for templates with a String as a template parameter to work correctly.

Template Parameters

kSize

The size of the string