cetl::basic_string_view< CharT, Traits > Class Template Reference

#include "cetl/pf17/string_view.hpp"

Public Types
enum	: size_type { npos = static_cast<size_type>(-1) }
using	traits_type = Traits
using	value_type = CharT
using	pointer = CharT*
using	const_pointer = const CharT*
using	reference = CharT&
using	const_reference = const CharT&
using	const_iterator = const CharT*
using	iterator = const_iterator
using	size_type = std::size_t
using	difference_type = std::ptrdiff_t

Public Member Functions
constexpr	basic_string_view () noexcept
	basic_string_view (const CharT *const str)
template<typename Alloc>
	basic_string_view (const std::basic_string< CharT, Traits, Alloc > &str)
constexpr	basic_string_view (const CharT *const str, const size_type size)
constexpr	basic_string_view (std::nullptr_t)=delete
constexpr size_type	size () const noexcept
constexpr size_type	length () const noexcept
constexpr size_type	max_size () const noexcept
constexpr bool	empty () const noexcept
constexpr const_reference	operator[] (const size_type pos) const
constexpr const_reference	at (const size_type pos) const
constexpr const_reference	front () const
constexpr const_reference	back () const
constexpr const_pointer	data () const noexcept
constexpr const_iterator	begin () const noexcept
constexpr const_iterator	end () const noexcept
constexpr const_iterator	cbegin () const noexcept
constexpr const_iterator	cend () const noexcept
constexpr void	remove_prefix (const size_type n)
constexpr void	remove_suffix (const size_type n)
constexpr void	swap (basic_string_view &sv) noexcept
size_type	copy (CharT *const dest, const size_type count, const size_type pos=0) const
constexpr basic_string_view	substr (const size_type pos=0, const size_type count=npos) const
int	compare (const basic_string_view sv) const noexcept
constexpr size_type	find (const CharT ch, const size_type pos=0) const noexcept
constexpr size_type	find (const basic_string_view sv, const size_type pos=0) const noexcept

Friends
bool	operator== (const basic_string_view lhs, const basic_string_view rhs) noexcept
bool	operator!= (const basic_string_view lhs, const basic_string_view rhs) noexcept
bool	operator< (const basic_string_view lhs, const basic_string_view rhs) noexcept
bool	operator> (const basic_string_view lhs, const basic_string_view rhs) noexcept
bool	operator<= (const basic_string_view lhs, const basic_string_view rhs) noexcept
bool	operator>= (const basic_string_view lhs, const basic_string_view rhs) noexcept
std::basic_ostream< CharT, Traits > &	operator<< (std::basic_ostream< CharT, Traits > &os, const basic_string_view &sv)

Detailed Description

template<typename CharT, typename Traits = std::char_traits<CharT>>
class cetl::basic_string_view< CharT, Traits >

The class template basic_string_view describes an object that can refer to a constant contiguous sequence of CharT with the first element of the sequence at position zero.

Constructor & Destructor Documentation

basic_string_view() [1/5]

template<typename CharT, typename Traits = std::char_traits<CharT>>

cetl::pf17::basic_string_view< CharT, Traits >::basic_string_view ( )

inlineconstexprnoexcept

Default constructor.

Constructs an empty basic_string_view. After construction, data() is equal to nullptr, and size() is equal to 0.

basic_string_view() [2/5]

template<typename CharT, typename Traits = std::char_traits<CharT>>

cetl::pf17::basic_string_view< CharT, Traits >::basic_string_view ( const CharT *const str )

inline

Constructs a view of the null-terminated character string pointed to by s, not including the terminating null character.

No lint and Sonar cpp:S1709 b/c this is an intentional implicit conversion.

NOLINTNEXTLINE(google-explicit-constructor, hicpp-explicit-conversions)

basic_string_view() [3/5]

template<typename CharT, typename Traits = std::char_traits<CharT>>

template<typename Alloc>

cetl::pf17::basic_string_view< CharT, Traits >::basic_string_view ( const std::basic_string< CharT, Traits, Alloc > & str )

inline

No lint and Sonar cpp:S1709 b/c this is an intentional implicit conversion.

NOLINTNEXTLINE(google-explicit-constructor, hicpp-explicit-conversions)

basic_string_view() [4/5]

template<typename CharT, typename Traits = std::char_traits<CharT>>

cetl::pf17::basic_string_view< CharT, Traits >::basic_string_view ( const CharT *const str, const size_type size )

inlineconstexpr

Constructs a view of the first count characters of the character array starting with the element pointed by str.

str can contain null characters.

basic_string_view() [5/5]

template<typename CharT, typename Traits = std::char_traits<CharT>>

cetl::pf17::basic_string_view< CharT, Traits >::basic_string_view ( std::nullptr_t )

constexprdelete

basic_string_view cannot be constructed from nullptr.

Member Function Documentation

at()

template<typename CharT, typename Traits = std::char_traits<CharT>>

const_reference cetl::pf17::basic_string_view< CharT, Traits >::at ( const size_type pos ) const

inlineconstexpr

Returns a const reference to the character at specified location pos.

Bounds checking is performed, exception of type std::out_of_range will be thrown on invalid access.

back()

template<typename CharT, typename Traits = std::char_traits<CharT>>

const_reference cetl::pf17::basic_string_view< CharT, Traits >::back ( ) const

inlineconstexpr

Returns reference to the last character in the view.

The behavior is undefined if empty() == true.

begin()

template<typename CharT, typename Traits = std::char_traits<CharT>>

const_iterator cetl::pf17::basic_string_view< CharT, Traits >::begin ( ) const

inlineconstexprnoexcept

Returns an iterator to the first character of the view.

cbegin()

template<typename CharT, typename Traits = std::char_traits<CharT>>

const_iterator cetl::pf17::basic_string_view< CharT, Traits >::cbegin ( ) const

inlineconstexprnoexcept

Returns a constant iterator to the first character of the view.

cend()

template<typename CharT, typename Traits = std::char_traits<CharT>>

const_iterator cetl::pf17::basic_string_view< CharT, Traits >::cend ( ) const

inlineconstexprnoexcept

Returns a constant iterator to the character following the last character of the view.

This character acts as a placeholder, attempting to access it results in undefined behavior.

compare()

template<typename CharT, typename Traits = std::char_traits<CharT>>

int cetl::pf17::basic_string_view< CharT, Traits >::compare ( const basic_string_view< CharT, Traits > sv ) const

inlinenoexcept

Compares two character sequences.

Returns

Negative value if this view is less than the other character sequence, zero if the both character sequences are equal, positive value if this view is greater than the other character sequence.

copy()

template<typename CharT, typename Traits = std::char_traits<CharT>>

size_type cetl::pf17::basic_string_view< CharT, Traits >::copy ( CharT *const dest, const size_type count, const size_type pos = 0 ) const

inline

Copies the substring [pos, pos + rcount) to the character array pointed to by dest, where rcount is the smaller of count and size() - pos.

Equivalent to Traits::copy(dest, data() + pos, rcount).

data()

template<typename CharT, typename Traits = std::char_traits<CharT>>

const_pointer cetl::pf17::basic_string_view< CharT, Traits >::data ( ) const

inlineconstexprnoexcept

Returns a pointer to the underlying character array.

The pointer is such that the range [data(), data() + size()) is valid and the values in it correspond to the values of the view.

empty()

template<typename CharT, typename Traits = std::char_traits<CharT>>

bool cetl::pf17::basic_string_view< CharT, Traits >::empty ( ) const

inlineconstexprnoexcept

Checks if the view has no characters, i.e.

whether size() == 0.

end()

template<typename CharT, typename Traits = std::char_traits<CharT>>

const_iterator cetl::pf17::basic_string_view< CharT, Traits >::end ( ) const

inlineconstexprnoexcept

Returns an iterator to the character following the last character of the view.

This character acts as a placeholder, attempting to access it results in undefined behavior.

find() [1/2]

template<typename CharT, typename Traits = std::char_traits<CharT>>

size_type cetl::pf17::basic_string_view< CharT, Traits >::find ( const basic_string_view< CharT, Traits > sv, const size_type pos = 0 ) const

inlineconstexprnoexcept

Finds the first substring equal to the given character sequence.

find() [2/2]

template<typename CharT, typename Traits = std::char_traits<CharT>>

size_type cetl::pf17::basic_string_view< CharT, Traits >::find ( const CharT ch, const size_type pos = 0 ) const

inlineconstexprnoexcept

Finds the first substring equal to the given character.

front()

template<typename CharT, typename Traits = std::char_traits<CharT>>

const_reference cetl::pf17::basic_string_view< CharT, Traits >::front ( ) const

inlineconstexpr

Returns reference to the first character in the view.

The behavior is undefined if empty() == true.

length()

template<typename CharT, typename Traits = std::char_traits<CharT>>

size_type cetl::pf17::basic_string_view< CharT, Traits >::length ( ) const

inlineconstexprnoexcept

Returns the number of CharT elements in the view, i.e.

std::distance(begin(), end()).

max_size()

template<typename CharT, typename Traits = std::char_traits<CharT>>

size_type cetl::pf17::basic_string_view< CharT, Traits >::max_size ( ) const

inlineconstexprnoexcept

The largest possible number of char-like objects that can be referred to by a basic_string_view.

operator[]()

template<typename CharT, typename Traits = std::char_traits<CharT>>

const_reference cetl::pf17::basic_string_view< CharT, Traits >::operator[] ( const size_type pos ) const

inlineconstexpr

Returns a const reference to the character at specified location pos.

remove_prefix()

template<typename CharT, typename Traits = std::char_traits<CharT>>

void cetl::pf17::basic_string_view< CharT, Traits >::remove_prefix ( const size_type n )

inlineconstexpr

Moves the start of the view forward by n characters.

The behavior is undefined if n > size().

remove_suffix()

template<typename CharT, typename Traits = std::char_traits<CharT>>

void cetl::pf17::basic_string_view< CharT, Traits >::remove_suffix ( const size_type n )

inlineconstexpr

Moves the end of the view back by n characters.

The behavior is undefined if n > size().

size()

template<typename CharT, typename Traits = std::char_traits<CharT>>

size_type cetl::pf17::basic_string_view< CharT, Traits >::size ( ) const

inlineconstexprnoexcept

Returns the number of CharT elements in the view, i.e.

std::distance(begin(), end()).

substr()

template<typename CharT, typename Traits = std::char_traits<CharT>>

basic_string_view cetl::pf17::basic_string_view< CharT, Traits >::substr ( const size_type pos = 0, const size_type count = npos ) const

inlineconstexpr

Returns a view of the substring [pos, pos + rlen), where rlen is the smaller of count and size() - pos.

swap()

template<typename CharT, typename Traits = std::char_traits<CharT>>

void cetl::pf17::basic_string_view< CharT, Traits >::swap ( basic_string_view< CharT, Traits > & sv )

inlineconstexprnoexcept

Exchanges the view with that of sv.

Friends And Related Symbol Documentation

operator<<

template<typename CharT, typename Traits = std::char_traits<CharT>>

std::basic_ostream< CharT, Traits > & operator<< ( std::basic_ostream< CharT, Traits > & os, const basic_string_view< CharT, Traits > & sv )

friend

Performs stream output on string view.

operator==

template<typename CharT, typename Traits = std::char_traits<CharT>>

bool operator== ( const basic_string_view< CharT, Traits > lhs, const basic_string_view< CharT, Traits > rhs )

friend

Compares two views.

---

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

• /__w/CETL/CETL/include/cetl/pf17/string_view.hpp