Member Function Documentation

Returns the index position of the last occurrence of the string-view str, Latin-1 string l1, or character ch, respectively, in this string-view, searching backward from index position from. If from is -1 (default), the search starts at the last character; if from is -2, at the next to last character and so on. Returns -1 if str is not found.

If cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive.

This documentation was introduced in Qt 5.14.

See also QString::lastIndexOf().

Returns true if this string-view contains an occurrence of the string-view str, Latin-1 string l1, or character ch; otherwise returns false.

If cs is Qt::CaseSensitive (the default), the search is case-sensitive; otherwise the search is case-insensitive.

This documentation was introduced in Qt 5.14.

See also indexOf().

Returns the index position of the first occurrence of the string-view str, Latin-1 string l1, or character ch, respectively, in this string-view, searching forward from index position from. Returns -1 if str is not found.

If cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive.

If from is -1, the search starts at the last character; if it is -2, at the next to last character and so on.

This documentation was introduced in Qt 5.14.

See also QString::indexOf().

Returns true if this string-view ends with string-view str, Latin-1 string l1, or character ch, respectively; otherwise returns false.

If cs is Qt::CaseSensitive (the default), the search is case-sensitive; otherwise the search is case-insensitive.

See also startsWith().

Returns true if this string-view starts with string-view str, Latin-1 string l1, or character ch, respectively; otherwise returns false.

If cs is Qt::CaseSensitive (the default), the search is case-sensitive; otherwise the search is case-insensitive.

See also endsWith().

QStringView::QStringView(const StdBasicString &str)

Constructs a string view on str. The length is taken from str.size().

str.data() must remain valid for the lifetime of this string view object.

This constructor only participates in overload resolution if StdBasicString is an instantiation of std::basic_string with a compatible character type. The compatible character types are: QChar, ushort, char16_t and (on platforms, such as Windows, where it is a 16-bit type) wchar_t.

The string view will be empty if and only if str.empty(). It is unspecified whether this constructor can result in a null string view (str.data() would have to return nullptr for this).

See also isNull() and isEmpty().

QStringView::QStringView(const QStringRef &str)

Constructs a string view on str.

str.data() must remain valid for the lifetime of this string view object.

The string view will be null if and only if str.isNull().

QStringView::QStringView(const QString &str)

Constructs a string view on str.

str.data() must remain valid for the lifetime of this string view object.

The string view will be null if and only if str.isNull().

QStringView::QStringView(const Char *str)

Constructs a string view on str. The length is determined by scanning for the first Char(0).

str must remain valid for the lifetime of this string view object.

Passing nullptr as str is safe and results in a null string view.

This constructor only participates in overload resolution if str is not an array and if Char is a compatible character type. The compatible character types are: QChar, ushort, char16_t and (on platforms, such as Windows, where it is a 16-bit type) wchar_t.

QStringView::QStringView(const Char (&)[N] string = ...)

Constructs a string view on the character string literal string. The length is set to N-1, excluding the trailing {Char(0)}. If you need the full array, use the constructor from pointer and size instead:

    auto sv = QStringView(array, std::size(array)); // using C++17 std::size()

string must remain valid for the lifetime of this string view object.

This constructor only participates in overload resolution if string is an actual array and Char is a compatible character type. The compatible character types are: QChar, ushort, char16_t and (on platforms, such as Windows, where it is a 16-bit type) wchar_t.

QStringView::QStringView(const Char *first, const Char *last)

Constructs a string view on first with length (last - first).

The range [first,last) must remain valid for the lifetime of this string view object.

Passing \nullptr as first is safe if last is nullptr, too, and results in a null string view.

The behavior is undefined if last precedes first, or first is nullptr and last is not.

This constructor only participates in overload resolution if Char is a compatible character type. The compatible character types are: QChar, ushort, char16_t and (on platforms, such as Windows, where it is a 16-bit type) wchar_t.

QStringView::QStringView(const Char *str, qsizetype len)

Constructs a string view on str with length len.

The range [str,len) must remain valid for the lifetime of this string view object.

Passing nullptr as str is safe if len is 0, too, and results in a null string view.

The behavior is undefined if len is negative or, when positive, if str is nullptr.

This constructor only participates in overload resolution if Char is a compatible character type. The compatible character types are: QChar, ushort, char16_t and (on platforms, such as Windows, where it is a 16-bit type) wchar_t.

QStringView::QStringView(std::nullptr_t)

Constructs a null string view.

See also isNull().

QStringView::QStringView()

Constructs a null string view.

See also isNull().

QChar QStringView::at(qsizetype n) const

Returns the character at position n in this string view.

The behavior is undefined if n is negative or not less than size().

See also operator[](), front(), and back().

QChar QStringView::back() const

Returns the last character in the string. Same as last().

This function is provided for STL compatibility.

Warning: Calling this function on an empty string view constitutes undefined behavior.

See also front(), first(), and last().

QStringView::const_iterator QStringView::begin() const

Returns a const STL-style iterator pointing to the first character in the string.

This function is provided for STL compatibility.

See also end(), cbegin(), rbegin(), and data().

QStringView::const_iterator QStringView::cbegin() const

Same as begin().

This function is provided for STL compatibility.

See also cend(), begin(), crbegin(), and data().

QStringView::const_iterator QStringView::cend() const

Same as end().

This function is provided for STL compatibility.

See also cbegin(), end(), and crend().

void QStringView::chop(qsizetype length)

Truncates this string view by length characters.

Same as *this = left(size() - length).

Note: The behavior is undefined when length < 0 or length > size().

See also mid(), left(), right(), chopped(), and truncate().

QStringView QStringView::chopped(qsizetype length) const

Returns the substring of length size() - length starting at the beginning of this object.

Same as left(size() - length).

Note: The behavior is undefined when length < 0 or length > size().

See also mid(), left(), right(), chop(), and truncate().

int QStringView::compare(QStringView other, Qt::CaseSensitivity cs = Qt::CaseSensitive) const

Compares this string-view with the other string-view and returns an integer less than, equal to, or greater than zero if this string-view is less than, equal to, or greater than the other string-view.

If cs is Qt::CaseSensitive, the comparison is case sensitive; otherwise the comparison is case insensitive.

This function was introduced in Qt 5.12.

See also operator==(), operator<(), and operator>().

QStringView::const_reverse_iterator QStringView::crbegin() const

Same as rbegin().

This function is provided for STL compatibility.

See also crend(), rbegin(), and cbegin().

QStringView::const_reverse_iterator QStringView::crend() const

Same as rend().

This function is provided for STL compatibility.

See also crbegin(), rend(), and cend().

QStringView::const_pointer QStringView::data() const

Returns a const pointer to the first character in the string.

Note: The character array represented by the return value is not null-terminated.

See also begin(), end(), and utf16().

bool QStringView::empty() const

Returns whether this string view is empty - that is, whether size() == 0.

This function is provided for STL compatibility.

See also isEmpty(), isNull(), size(), and length().

QStringView::const_iterator QStringView::end() const

Returns a const STL-style iterator pointing to the imaginary character after the last character in the list.

This function is provided for STL compatibility.

See also begin(), cend(), and rend().

QChar QStringView::first() const

Returns the first character in the string. Same as front().

This function is provided for compatibility with other Qt containers.

Warning: Calling this function on an empty string view constitutes undefined behavior.

See also front(), back(), and last().

QChar QStringView::front() const

Returns the first character in the string. Same as first().

This function is provided for STL compatibility.

Warning: Calling this function on an empty string view constitutes undefined behavior.

See also back(), first(), and last().

bool QStringView::isEmpty() const

Returns whether this string view is empty - that is, whether size() == 0.

This function is provided for compatibility with other Qt containers.

See also empty(), isNull(), size(), and length().

bool QStringView::isNull() const

Returns whether this string view is null - that is, whether data() == nullptr.

This functions is provided for compatibility with other Qt containers.

See also empty(), isEmpty(), size(), and length().

bool QStringView::isRightToLeft() const

Returns true if the string is read right to left.

This function was introduced in Qt 5.11.

See also QString::isRightToLeft().

QChar QStringView::last() const

Returns the last character in the string. Same as back().

This function is provided for compatibility with other Qt containers.

Warning: Calling this function on an empty string view constitutes undefined behavior.

See also back(), front(), and first().

QStringView QStringView::left(qsizetype length) const

Returns the substring of length length starting at position 0 in this object.

Note: The behavior is undefined when length < 0 or length > size().

See also mid(), right(), chopped(), chop(), and truncate().

int QStringView::length() const

Same as size(), except returns the result as an int.

This function is provided for compatibility with other Qt containers.

Warning: QStringView can represent strings with more than 2³¹ characters. Calling this function on a string view for which size() returns a value greater than INT_MAX constitutes undefined behavior.

See also empty(), isEmpty(), isNull(), and size().

QStringView QStringView::mid(qsizetype start) const

Returns the substring starting at position start in this object, and extending to the end of the string.

Note: The behavior is undefined when start < 0 or start > size().

See also left(), right(), chopped(), chop(), and truncate().

QStringView QStringView::mid(qsizetype start, qsizetype length) const

This is an overloaded function.

Returns the substring of length length starting at position start in this object.

Note: The behavior is undefined when start < 0, length < 0, or start + length > size().

See also left(), right(), chopped(), chop(), and truncate().

QStringView::const_reverse_iterator QStringView::rbegin() const

Returns a const STL-style reverse iterator pointing to the first character in the string, in reverse order.

This function is provided for STL compatibility.

See also rend(), crbegin(), and begin().

QStringView::const_reverse_iterator QStringView::rend() const

Returns a STL-style reverse iterator pointing to one past the last character in the string, in reverse order.

This function is provided for STL compatibility.

See also rbegin(), crend(), and end().

QStringView QStringView::right(qsizetype length) const

Returns the substring of length length starting at position size() - length in this object.

Note: The behavior is undefined when length < 0 or length > size().

See also mid(), left(), chopped(), chop(), and truncate().

qsizetype QStringView::size() const

Returns the size of this string view, in UTF-16 code points (that is, surrogate pairs count as two for the purposes of this function, the same as in QString and QStringRef).

See also empty(), isEmpty(), isNull(), and length().

QByteArray QStringView::toLatin1() const

Returns a Latin-1 representation of the string as a QByteArray.

The behavior is undefined if the string contains non-Latin1 characters.

See also toUtf8(), toLocal8Bit(), and QTextCodec.

QByteArray QStringView::toLocal8Bit() const

Returns a local 8-bit representation of the string as a QByteArray.

QTextCodec::codecForLocale() is used to perform the conversion from Unicode. If the locale's encoding could not be determined, this function does the same as toLatin1().

The behavior is undefined if the string contains characters not supported by the locale's 8-bit encoding.

See also toLatin1(), toUtf8(), and QTextCodec.

QString QStringView::toString() const

Returns a deep copy of this string view's data as a QString.

The return value will be the null QString if and only if this string view is null.

Warning: QStringView can store strings with more than 2³⁰ characters while QString cannot. Calling this function on a string view for which size() returns a value greater than INT_MAX / 2 constitutes undefined behavior.

QVector<uint> QStringView::toUcs4() const

Returns a UCS-4/UTF-32 representation of the string as a QVector<uint>.

UCS-4 is a Unicode codec and therefore it is lossless. All characters from this string will be encoded in UCS-4. Any invalid sequence of code units in this string is replaced by the Unicode replacement character (QChar::ReplacementCharacter, which corresponds to U+FFFD).

The returned vector is not 0-terminated.

See also toUtf8(), toLatin1(), toLocal8Bit(), and QTextCodec.

QByteArray QStringView::toUtf8() const

Returns a UTF-8 representation of the string as a QByteArray.

UTF-8 is a Unicode codec and can represent all characters in a Unicode string like QString.

See also toLatin1(), toLocal8Bit(), and QTextCodec.

int QStringView::toWCharArray(wchar_t *array) const

Transcribes this string into the given array.

The caller is responsible for ensuring array is large enough to hold the wchar_t encoding of this string (allocating the array with the same length as the string is always sufficient). The array is encoded in UTF-16 on platforms where wchar_t is 2 bytes wide (e.g. Windows); otherwise (Unix systems), wchar_t is assumed to be 4 bytes wide and the data is written in UCS-4.

Note: This function writes no null terminator to the end of array.

Returns the number of wchar_t entries written to array.

This function was introduced in Qt 5.14.

See also QString::toWCharArray().

QStringView QStringView::trimmed() const

Strips leading and trailing whitespace and returns the result.

Whitespace means any character for which QChar::isSpace() returns true. This includes the ASCII characters '\t', '\n', '\v', '\f', '\r', and ' '.

void QStringView::truncate(qsizetype length)

Truncates this string view to length length.

Same as *this = left(length).

Note: The behavior is undefined when length < 0 or length > size().

See also mid(), left(), right(), chopped(), and chop().

const QStringView::storage_type *QStringView::utf16() const

Returns a const pointer to the first character in the string.

storage_type is char16_t.

Note: The character array represented by the return value is not null-terminated.

See also begin(), end(), and data().

QChar QStringView::operator[](qsizetype n) const

Returns the character at position n in this string view.

The behavior is undefined if n is negative or not less than size().

See also at(), front(), and back().