Struct qt_core::QStringRef

The QStringRef class provides a thin wrapper around QString substrings.

QStringRef provides a read-only subset of the QString API.

A string reference explicitly references a portion of a string() with a given size(), starting at a specific position(). Calling toString() returns a copy of the data as a real QString instance.

This class is designed to improve the performance of substring handling when manipulating substrings obtained from existing QString instances. QStringRef avoids the memory allocation and reference counting overhead of a standard QString by simply referencing a part of the original string. This can prove to be advantageous in low level code, such as that used in a parser, at the expense of potentially more complex code.

For most users, there are no semantic benefits to using QStringRef instead of QString since QStringRef requires attention to be paid to memory management issues, potentially making code more complex to write and maintain.

Warning: A QStringRef is only valid as long as the referenced string exists. If the original string is deleted, the string reference points to an invalid memory location.

We suggest that you only use this class in stable code where profiling has clearly identified that performance improvements can be made by replacing standard string operations with the optimized substring handling provided by this class.

Implementations§

impl QStringRef

pub unsafe fn append_to( &self, string: impl CastInto<Ptr<QString>> ) -> CppBox<QStringRef>

Appends the string reference to string, and returns a new reference to the combined string data.

Calls C++ function: QStringRef QStringRef::appendTo(QString* string) const.

Appends the string reference to string, and returns a new reference to the combined string data.

pub unsafe fn at(&self, i: c_int) -> CppBox<QChar>

Returns the character at the given index position in the string reference.

Calls C++ function: QChar QStringRef::at(int i) const.

Returns the character at the given index position in the string reference.

The position must be a valid index position in the string (i.e., 0 <= position < size()).

pub unsafe fn back(&self) -> CppBox<QChar>

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Returns the last character in the string. Same as at(size() - 1).

Calls C++ function: QChar QStringRef::back() const.

Returns the last character in the string. Same as at(size() - 1).

This function is provided for STL compatibility.

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

This function was introduced in Qt 5.10.

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

pub unsafe fn begin(&self) -> Ptr<QChar>

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

Calls C++ function: const QChar* QStringRef::begin() const.

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

This function was introduced in Qt 5.4.

See also cbegin(), constBegin(), end(), constEnd(), rbegin(), and rend().

pub unsafe fn cbegin(&self) -> Ptr<QChar>

Same as begin().

Calls C++ function: const QChar* QStringRef::cbegin() const.

Same as begin().

This function was introduced in Qt 5.4.

See also begin(), constBegin(), cend(), constEnd(), rbegin(), and rend().

pub unsafe fn cend(&self) -> Ptr<QChar>

Same as end().

Calls C++ function: const QChar* QStringRef::cend() const.

Same as end().

This function was introduced in Qt 5.4.

See also end(), constEnd(), cbegin(), constBegin(), rbegin(), and rend().

pub unsafe fn chop(&self, n: c_int)

Removes n characters from the end of the string.

Calls C++ function: void QStringRef::chop(int n).

Removes n characters from the end of the string.

If n is greater than or equal to size(), the result is an empty string; if n is negative, it is equivalent to passing zero.

This function was introduced in Qt 5.8.

See also QString::chop() and truncate().

pub unsafe fn chopped(&self, n: c_int) -> CppBox<QStringRef>

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Returns a substring reference to the size() - len leftmost characters of this string.

Calls C++ function: QStringRef QStringRef::chopped(int n) const.

Returns a substring reference to the size() - len leftmost characters of this string.

Note: The behavior is undefined if len is negative or greater than size().

Compares the string s1 with the string s2 and returns an integer less than, equal to, or greater than zero if s1 is less than, equal to, or greater than s2.

Calls C++ function: static int QStringRef::compare(const QStringRef& s1, const QString& s2, Qt::CaseSensitivity arg3 = …).

Compares the string s1 with the string s2 and returns an integer less than, equal to, or greater than zero if s1 is less than, equal to, or greater than s2.

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

This function was introduced in Qt 4.5.

pub unsafe fn compare_2_q_string_ref_case_sensitivity( s1: impl CastInto<Ref<QStringRef>>, s2: impl CastInto<Ref<QStringRef>>, arg3: CaseSensitivity ) -> c_int

This is an overloaded function.

Calls C++ function: static int QStringRef::compare(const QStringRef& s1, const QStringRef& s2, Qt::CaseSensitivity arg3 = …).

This is an overloaded function.

Compares the string s1 with the string s2 and returns an integer less than, equal to, or greater than zero if s1 is less than, equal to, or greater than s2.

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

This function was introduced in Qt 4.5.

Compares the string s1 with the string s2 and returns an integer less than, equal to, or greater than zero if s1 is less than, equal to, or greater than s2.

Calls C++ function: static int QStringRef::compare(const QStringRef& s1, const QString& s2).

Compares the string s1 with the string s2 and returns an integer less than, equal to, or greater than zero if s1 is less than, equal to, or greater than s2.

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

This function was introduced in Qt 4.5.

pub unsafe fn compare_2_q_string_ref( s1: impl CastInto<Ref<QStringRef>>, s2: impl CastInto<Ref<QStringRef>> ) -> c_int

This is an overloaded function.

Calls C++ function: static int QStringRef::compare(const QStringRef& s1, const QStringRef& s2).

This is an overloaded function.

Compares the string s1 with the string s2 and returns an integer less than, equal to, or greater than zero if s1 is less than, equal to, or greater than s2.

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

This function was introduced in Qt 4.5.

pub unsafe fn compare_q_string_ref_q_latin1_string( s1: impl CastInto<Ref<QStringRef>>, s2: impl CastInto<Ref<QLatin1String>> ) -> c_int

This is an overloaded function.

Calls C++ function: static int QStringRef::compare(const QStringRef& s1, QLatin1String s2).

This is an overloaded function.

Compares the string s1 with the string s2 and returns an integer less than, equal to, or greater than zero if s1 is less than, equal to, or greater than s2.

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

This function was introduced in Qt 4.5.

pub unsafe fn const_begin(&self) -> Ptr<QChar>

Same as begin().

Calls C++ function: const QChar* QStringRef::constBegin() const.

Same as begin().

This function was introduced in Qt 5.9.

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

pub unsafe fn const_data(&self) -> Ptr<QChar>

Same as unicode().

Calls C++ function: const QChar* QStringRef::constData() const.

Same as unicode().

This function overloads contains().

Calls C++ function: bool QStringRef::contains(QLatin1String str, Qt::CaseSensitivity cs = …) const.

This function overloads contains().

Returns true if this string reference contains an occurrence of the string str; otherwise returns false.

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

This function was introduced in Qt 4.8.

See also indexOf() and count().

pub unsafe fn contains_q_string_ref_case_sensitivity( &self, str: impl CastInto<Ref<QStringRef>>, cs: CaseSensitivity ) -> bool

This function overloads contains().

Calls C++ function: bool QStringRef::contains(const QStringRef& str, Qt::CaseSensitivity cs = …) const.

This function overloads contains().

Returns true if this string reference contains an occurrence of the string reference str; otherwise returns false.

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

This function was introduced in Qt 4.8.

See also indexOf() and count().

pub unsafe fn contains_q_string(&self, str: impl CastInto<Ref<QString>>) -> bool

Returns true if this string reference contains an occurrence of the string str; otherwise returns false.

Calls C++ function: bool QStringRef::contains(const QString& str) const.

Returns true if this string reference contains an occurrence of the string str; otherwise returns false.

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

This function was introduced in Qt 4.8.

See also indexOf() and count().

Available on cpp_lib_version="5.14.0" only.

This function overloads contains().

Calls C++ function: bool QStringRef::contains(QStringView str, Qt::CaseSensitivity cs = …) const.

This function overloads contains().

Returns true if this string reference contains an occurrence of the string view str; otherwise returns false.

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

This function was introduced in Qt 5.14.

See also indexOf() and count().

pub unsafe fn contains_q_string_view( &self, str: impl CastInto<Ref<QStringView>> ) -> bool

Available on cpp_lib_version="5.14.0" only.

This function overloads contains().

Calls C++ function: bool QStringRef::contains(QStringView str) const.

This function overloads contains().

Returns true if this string reference contains an occurrence of the string view str; otherwise returns false.

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

This function was introduced in Qt 5.14.

See also indexOf() and count().

pub unsafe fn copy_from_q_string_ref( &self, other: impl CastInto<Ref<QStringRef>> ) -> Ref<QStringRef>

Assigns the other string reference to this string reference, and returns the result.

Calls C++ function: QStringRef& QStringRef::operator=(const QStringRef& other).

Assigns the other string reference to this string reference, and returns the result.

pub unsafe fn copy_from_q_string( &self, string: impl CastInto<Ptr<QString>> ) -> Ref<QStringRef>

Constructs a string reference to the given string and assigns it to this string reference, returning the result.

Calls C++ function: QStringRef& QStringRef::operator=(const QString* string).

Constructs a string reference to the given string and assigns it to this string reference, returning the result.

pub unsafe fn count(&self) -> c_int

Returns the number of characters referred to by the string reference. Equivalent to size() and length().

Calls C++ function: int QStringRef::count() const.

Returns the number of characters referred to by the string reference. Equivalent to size() and length().

See also position() and string().

Returns the number of (potentially overlapping) occurrences of the string str in this string reference.

Calls C++ function: int QStringRef::count(const QString& s) const.

Returns the number of (potentially overlapping) occurrences of the string str in this string reference.

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

This function was introduced in Qt 4.8.

See also QString::count(), contains(), and indexOf().

pub unsafe fn count_q_char(&self, c: impl CastInto<Ref<QChar>>) -> c_int

This function overloads count().

Calls C++ function: int QStringRef::count(QChar c) const.

This function overloads count().

Returns the number of occurrences of the character ch in the string reference.

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

This function was introduced in Qt 4.8.

See also QString::count(), contains(), and indexOf().

pub unsafe fn count_q_string_ref( &self, s: impl CastInto<Ref<QStringRef>> ) -> c_int

This function overloads count().

Calls C++ function: int QStringRef::count(const QStringRef& s) const.

This function overloads count().

Returns the number of (potentially overlapping) occurrences of the string reference str in this string reference.

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

This function was introduced in Qt 4.8.

See also QString::count(), contains(), and indexOf().

pub unsafe fn data(&self) -> Ptr<QChar>

Same as unicode().

Calls C++ function: const QChar* QStringRef::data() const.

Same as unicode().

pub unsafe fn end(&self) -> Ptr<QChar>

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

Calls C++ function: const QChar* QStringRef::end() const.

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

This function was introduced in Qt 5.4.

See also cbegin(), constBegin(), end(), constEnd(), rbegin(), and rend().

pub unsafe fn ends_with_q_string_case_sensitivity( &self, s: impl CastInto<Ref<QString>>, cs: CaseSensitivity ) -> bool

Returns true if the string reference ends with str; otherwise returns false.

Calls C++ function: bool QStringRef::endsWith(const QString& s, Qt::CaseSensitivity cs = …) const.

Returns true if the string reference ends with str; otherwise returns false.

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

This function was introduced in Qt 4.8.

See also QString::endsWith() and startsWith().

pub unsafe fn ends_with_q_latin1_string_case_sensitivity( &self, s: impl CastInto<Ref<QLatin1String>>, cs: CaseSensitivity ) -> bool

This function overloads endsWith().

Calls C++ function: bool QStringRef::endsWith(QLatin1String s, Qt::CaseSensitivity cs = …) const.

This function overloads endsWith().

This function was introduced in Qt 4.8.

See also QString::endsWith() and endsWith().

pub unsafe fn ends_with_q_char_case_sensitivity( &self, c: impl CastInto<Ref<QChar>>, cs: CaseSensitivity ) -> bool

This function overloads endsWith().

Calls C++ function: bool QStringRef::endsWith(QChar c, Qt::CaseSensitivity cs = …) const.

This function overloads endsWith().

Returns true if the string reference ends with ch; otherwise returns false.

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

This function was introduced in Qt 4.8.

See also QString::endsWith() and endsWith().

pub unsafe fn ends_with_q_string_ref_case_sensitivity( &self, c: impl CastInto<Ref<QStringRef>>, cs: CaseSensitivity ) -> bool

This function overloads endsWith().

Calls C++ function: bool QStringRef::endsWith(const QStringRef& c, Qt::CaseSensitivity cs = …) const.

This function overloads endsWith().

This function was introduced in Qt 4.8.

See also QString::endsWith() and endsWith().

pub unsafe fn ends_with_q_string(&self, s: impl CastInto<Ref<QString>>) -> bool

Returns true if the string reference ends with str; otherwise returns false.

Calls C++ function: bool QStringRef::endsWith(const QString& s) const.

Returns true if the string reference ends with str; otherwise returns false.

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

This function was introduced in Qt 4.8.

See also QString::endsWith() and startsWith().

pub unsafe fn ends_with_q_latin1_string( &self, s: impl CastInto<Ref<QLatin1String>> ) -> bool

This function overloads endsWith().

Calls C++ function: bool QStringRef::endsWith(QLatin1String s) const.

This function overloads endsWith().

This function was introduced in Qt 4.8.

See also QString::endsWith() and endsWith().

pub unsafe fn ends_with_q_char(&self, c: impl CastInto<Ref<QChar>>) -> bool

This function overloads endsWith().

Calls C++ function: bool QStringRef::endsWith(QChar c) const.

This function overloads endsWith().

Returns true if the string reference ends with ch; otherwise returns false.

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

This function was introduced in Qt 4.8.

See also QString::endsWith() and endsWith().

Available on cpp_lib_version="5.11.3" or cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

Calls C++ function: QChar QStringRef::front() const.

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

This function is provided for STL compatibility.

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

This function was introduced in Qt 5.10.

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

pub unsafe fn index(&self, i: c_int) -> CppBox<QChar>

Returns the character at the given index position in the string reference.

Calls C++ function: QChar QStringRef::operator[](int i) const.

Returns the character at the given index position in the string reference.

The position must be a valid index position in the string reference (i.e., 0 <= position < size()).

This function was introduced in Qt 5.7.

See also at().

pub unsafe fn index_of_q_string_int_case_sensitivity( &self, str: impl CastInto<Ref<QString>>, from: c_int, cs: CaseSensitivity ) -> c_int

Returns the index position of the first occurrence of the string str in this string reference, searching forward from index position from. Returns -1 if str is not found.

Calls C++ function: int QStringRef::indexOf(const QString& str, int from = …, Qt::CaseSensitivity cs = …) const.

Returns the index position of the first occurrence of the string str in this string reference, 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 function was introduced in Qt 4.8.

See also QString::indexOf(), lastIndexOf(), contains(), and count().

This function overloads indexOf().

Calls C++ function: int QStringRef::indexOf(QChar ch, int from = …) const.

This function overloads indexOf().

Returns the index position of the first occurrence of the character ch in the string reference, searching forward from index position from. Returns -1 if ch could not be found.

This function was introduced in Qt 4.8.

See also QString::indexOf(), lastIndexOf(), contains(), and count().

Available on cpp_lib_version="5.14.0" only.

This function overloads indexOf().

Calls C++ function: int QStringRef::indexOf(QStringView s, int from = …, Qt::CaseSensitivity cs = …) const.

This function overloads indexOf().

Returns the index position of the first occurrence of the string view str in this string reference, 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 function was introduced in Qt 5.14.

See also QString::indexOf(), QStringView::indexOf(), lastIndexOf(), contains(), and count().

pub unsafe fn index_of_q_string_view_int( &self, s: impl CastInto<Ref<QStringView>>, from: c_int ) -> c_int

Available on cpp_lib_version="5.14.0" only.

This function overloads indexOf().

Calls C++ function: int QStringRef::indexOf(QStringView s, int from = …) const.

This function overloads indexOf().

Returns the index position of the first occurrence of the string view str in this string reference, 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 function was introduced in Qt 5.14.

See also QString::indexOf(), QStringView::indexOf(), lastIndexOf(), contains(), and count().

pub unsafe fn index_of_q_string_view( &self, s: impl CastInto<Ref<QStringView>> ) -> c_int

Available on cpp_lib_version="5.14.0" only.

This function overloads indexOf().

Calls C++ function: int QStringRef::indexOf(QStringView s) const.

This function overloads indexOf().

Returns the index position of the first occurrence of the string view str in this string reference, 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 function was introduced in Qt 5.14.

See also QString::indexOf(), QStringView::indexOf(), lastIndexOf(), contains(), and count().

pub unsafe fn is_empty(&self) -> bool

Returns true if the string reference has no characters; otherwise returns false.

Calls C++ function: bool QStringRef::isEmpty() const.

Returns true if the string reference has no characters; otherwise returns false.

A string reference is empty if its size is zero.

See also size().

pub unsafe fn is_null(&self) -> bool

Returns true if string() returns a null pointer or a pointer to a null string; otherwise returns true.

Calls C++ function: bool QStringRef::isNull() const.

Returns true if string() returns a null pointer or a pointer to a null string; otherwise returns true.

See also size().

This function overloads lastIndexOf().

Calls C++ function: int QStringRef::lastIndexOf(QLatin1String str, int from = …, Qt::CaseSensitivity cs = …) const.

This function overloads lastIndexOf().

Returns the index position of the last occurrence of the string str in this string reference, 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 function was introduced in Qt 4.8.

See also QString::lastIndexOf(), indexOf(), contains(), and count().

pub unsafe fn last_index_of_q_string_ref_int_case_sensitivity( &self, str: impl CastInto<Ref<QStringRef>>, from: c_int, cs: CaseSensitivity ) -> c_int

This function overloads lastIndexOf().

Calls C++ function: int QStringRef::lastIndexOf(const QStringRef& str, int from = …, Qt::CaseSensitivity cs = …) const.

This function overloads lastIndexOf().

Returns the index position of the last occurrence of the string reference str in this string reference, 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 function was introduced in Qt 4.8.

See also QString::lastIndexOf(), indexOf(), contains(), and count().

pub unsafe fn last_index_of_q_string_int( &self, str: impl CastInto<Ref<QString>>, from: c_int ) -> c_int

Returns the index position of the last occurrence of the string str in this string reference, 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.

Calls C++ function: int QStringRef::lastIndexOf(const QString& str, int from = …) const.

Returns the index position of the last occurrence of the string str in this string reference, 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 function was introduced in Qt 4.8.

See also QString::lastIndexOf(), indexOf(), contains(), and count().

pub unsafe fn last_index_of_q_string( &self, str: impl CastInto<Ref<QString>> ) -> c_int

Returns the index position of the last occurrence of the string str in this string reference, 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.

Calls C++ function: int QStringRef::lastIndexOf(const QString& str) const.

Returns the index position of the last occurrence of the string str in this string reference, 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 function was introduced in Qt 4.8.

See also QString::lastIndexOf(), indexOf(), contains(), and count().

pub unsafe fn last_index_of_q_char_int( &self, ch: impl CastInto<Ref<QChar>>, from: c_int ) -> c_int

This function overloads lastIndexOf().

Calls C++ function: int QStringRef::lastIndexOf(QChar ch, int from = …) const.

This function overloads lastIndexOf().

Returns the index position of the last occurrence of the character ch, searching backward from position from.

This function was introduced in Qt 4.8.

See also QString::lastIndexOf(), indexOf(), contains(), and count().

Available on cpp_lib_version="5.14.0" only.

This function overloads lastIndexOf().

Calls C++ function: int QStringRef::lastIndexOf(QStringView s, int from = …, Qt::CaseSensitivity cs = …) const.

This function overloads lastIndexOf().

Returns the index position of the last occurrence of the string view str in this string, 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 function was introduced in Qt 5.14.

See also indexOf(), contains(), and count().

pub unsafe fn last_index_of_q_string_view_int( &self, s: impl CastInto<Ref<QStringView>>, from: c_int ) -> c_int

Available on cpp_lib_version="5.14.0" only.

This function overloads lastIndexOf().

Calls C++ function: int QStringRef::lastIndexOf(QStringView s, int from = …) const.

This function overloads lastIndexOf().

Returns the index position of the last occurrence of the string view str in this string, 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 function was introduced in Qt 5.14.

See also indexOf(), contains(), and count().

pub unsafe fn last_index_of_q_string_view( &self, s: impl CastInto<Ref<QStringView>> ) -> c_int

Available on cpp_lib_version="5.14.0" only.

This function overloads lastIndexOf().

Calls C++ function: int QStringRef::lastIndexOf(QStringView s) const.

This function overloads lastIndexOf().

Returns the index position of the last occurrence of the string view str in this string, 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 function was introduced in Qt 5.14.

See also indexOf(), contains(), and count().

pub unsafe fn left(&self, n: c_int) -> CppBox<QStringRef>

Returns a substring reference to the n leftmost characters of the string.

Calls C++ function: QStringRef QStringRef::left(int n) const.

Returns a substring reference to the n leftmost characters of the string.

If n is greater than or equal to size(), or less than zero, a reference to the entire string is returned.

This function was introduced in Qt 5.2.

See also right(), mid(), and startsWith().

Compares s1 with s2 and returns an integer less than, equal to, or greater than zero if s1 is less than, equal to, or greater than s2.

Calls C++ function: static int QStringRef::localeAwareCompare(const QStringRef& s1, const QString& s2).

Compares s1 with s2 and returns an integer less than, equal to, or greater than zero if s1 is less than, equal to, or greater than s2.

The comparison is performed in a locale- and also platform-dependent manner. Use this function to present sorted lists of strings to the user.

On macOS and iOS, this function compares according the "Order for sorted lists" setting in the International prefereces panel.

This function was introduced in Qt 4.5.

See also compare() and QLocale.

Constructs an empty string reference.

Calls C++ function: [constructor] void QStringRef::QStringRef().

Constructs an empty string reference.

pub unsafe fn new_3a( string: impl CastInto<Ptr<QString>>, position: c_int, size: c_int ) -> CppBox<QStringRef>

Constructs a string reference to the range of characters in the given string specified by the starting position and length in characters.

Calls C++ function: [constructor] void QStringRef::QStringRef(const QString* string, int position, int size).

Constructs a string reference to the range of characters in the given string specified by the starting position and length in characters.

Warning: This function exists to improve performance as much as possible, and performs no bounds checking. For program correctness, position and length must describe a valid substring of string.

This means that the starting position must be positive or 0 and smaller than string's length, and length must be positive or 0 but smaller than the string's length minus the starting position; i.e, 0 <= position < string->length() and 0 <= length <= string->length() - position must both be satisfied.

pub unsafe fn new_1a(string: impl CastInto<Ptr<QString>>) -> CppBox<QStringRef>

Constructs a string reference to the given string.

Calls C++ function: [constructor] void QStringRef::QStringRef(const QString* string).

Constructs a string reference to the given string.

pub unsafe fn new_copy( other: impl CastInto<Ref<QStringRef>> ) -> CppBox<QStringRef>

Constructs a copy of the other string reference.

Calls C++ function: [constructor] void QStringRef::QStringRef(const QStringRef& other).

Constructs a copy of the other string reference.

pub unsafe fn position(&self) -> c_int

Returns the starting position in the referenced string that is referred to by the string reference.

Calls C++ function: int QStringRef::position() const.

Returns the starting position in the referenced string that is referred to by the string reference.

See also size() and string().

pub unsafe fn right(&self, n: c_int) -> CppBox<QStringRef>

Returns a substring reference to the n rightmost characters of the string.

Calls C++ function: QStringRef QStringRef::right(int n) const.

Returns a substring reference to the n rightmost characters of the string.

If n is greater than or equal to size(), or less than zero, a reference to the entire string is returned.

This function was introduced in Qt 5.2.

See also left(), mid(), and endsWith().

pub unsafe fn size(&self) -> c_int

Returns the number of characters referred to by the string reference. Equivalent to length() and count().

Calls C++ function: int QStringRef::size() const.

Returns the number of characters referred to by the string reference. Equivalent to length() and count().

See also position() and string().

pub unsafe fn split_q_string_split_behavior_case_sensitivity( &self, sep: impl CastInto<Ref<QString>>, behavior: SplitBehavior, cs: CaseSensitivity ) -> CppBox<QVectorOfQStringRef>

Splits the string into substrings references wherever sep occurs, and returns the list of those strings.

Calls C++ function: QVector<QStringRef> QStringRef::split(const QString& sep, QString::SplitBehavior behavior = …, Qt::CaseSensitivity cs = …) const.

Splits the string into substrings references wherever sep occurs, and returns the list of those strings.

See QString::split() for how sep, behavior and cs interact to form the result.

Note: All references are valid as long this string is alive. Destroying this string will cause all references be dangling pointers.

This function was introduced in Qt 5.4.

This is an overloaded function.

Calls C++ function: QVector<QStringRef> QStringRef::split(QChar sep, QString::SplitBehavior behavior = …) const.

This is an overloaded function.

This function was introduced in Qt 5.4.

pub unsafe fn split_q_char( &self, sep: impl CastInto<Ref<QChar>> ) -> CppBox<QVectorOfQStringRef>

This is an overloaded function.

Calls C++ function: QVector<QStringRef> QStringRef::split(QChar sep) const.

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

This function was introduced in Qt 4.8.

See also QString::startsWith() and endsWith().

pub unsafe fn starts_with_q_latin1_string_case_sensitivity( &self, s: impl CastInto<Ref<QLatin1String>>, cs: CaseSensitivity ) -> bool

This function overloads startsWith().

Calls C++ function: bool QStringRef::startsWith(QLatin1String s, Qt::CaseSensitivity cs = …) const.

This function overloads startsWith().

This function was introduced in Qt 4.8.

See also QString::startsWith() and endsWith().

pub unsafe fn starts_with_q_char_case_sensitivity( &self, c: impl CastInto<Ref<QChar>>, cs: CaseSensitivity ) -> bool

This function overloads startsWith().

Calls C++ function: bool QStringRef::startsWith(QChar c, Qt::CaseSensitivity cs = …) const.

This function overloads startsWith().

Returns true if the string reference starts with ch; otherwise returns false.

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

This function was introduced in Qt 4.8.

See also QString::startsWith() and endsWith().

pub unsafe fn starts_with_q_string_ref_case_sensitivity( &self, c: impl CastInto<Ref<QStringRef>>, cs: CaseSensitivity ) -> bool

This function overloads startsWith().

Calls C++ function: bool QStringRef::startsWith(const QStringRef& c, Qt::CaseSensitivity cs = …) const.

This function overloads startsWith().

This function was introduced in Qt 4.8.

See also QString::startsWith() and endsWith().

pub unsafe fn starts_with_q_string( &self, s: impl CastInto<Ref<QString>> ) -> bool

Returns true if the string reference starts with str; otherwise returns false.

Calls C++ function: bool QStringRef::startsWith(const QString& s) const.

Returns true if the string reference starts with str; otherwise returns false.

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

This function was introduced in Qt 4.8.

See also QString::startsWith() and endsWith().

pub unsafe fn starts_with_q_latin1_string( &self, s: impl CastInto<Ref<QLatin1String>> ) -> bool

This function overloads startsWith().

Calls C++ function: bool QStringRef::startsWith(QLatin1String s) const.

This function overloads startsWith().

This function was introduced in Qt 4.8.

See also QString::startsWith() and endsWith().

pub unsafe fn starts_with_q_char(&self, c: impl CastInto<Ref<QChar>>) -> bool

This function overloads startsWith().

Calls C++ function: bool QStringRef::startsWith(QChar c) const.

This function overloads startsWith().

Returns true if the string reference starts with ch; otherwise returns false.

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

This function was introduced in Qt 4.8.

See also QString::startsWith() and endsWith().

Returns a pointer to the string referred to by the string reference, or 0 if it does not reference a string.

Calls C++ function: const QString* QStringRef::string() const.

Returns a pointer to the string referred to by the string reference, or 0 if it does not reference a string.

See also unicode().

pub unsafe fn to_double_1a(&self, ok: *mut bool) -> c_double

Returns the string converted to a double value.

Calls C++ function: double QStringRef::toDouble(bool* ok = …) const.

Returns the string converted to a double value.

Returns 0.0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toDouble()

For historic reasons, this function does not handle thousands group separators. If you need to convert such numbers, use QLocale::toDouble().

This function was introduced in Qt 5.1.

See also QString::toDouble().

pub unsafe fn to_double_0a(&self) -> c_double

Returns the string converted to a double value.

Calls C++ function: double QStringRef::toDouble() const.

Returns the string converted to a double value.

Returns 0.0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toDouble()

For historic reasons, this function does not handle thousands group separators. If you need to convert such numbers, use QLocale::toDouble().

This function was introduced in Qt 5.1.

See also QString::toDouble().

pub unsafe fn to_float_1a(&self, ok: *mut bool) -> c_float

Returns the string converted to a float value.

Calls C++ function: float QStringRef::toFloat(bool* ok = …) const.

Returns the string converted to a float value.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true. Returns 0.0 if the conversion fails.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toFloat()

This function was introduced in Qt 5.1.

See also QString::toFloat().

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

Calls C++ function: QByteArray QStringRef::toLatin1() const.

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

The returned byte array is undefined if the string contains non-Latin1 characters. Those characters may be suppressed or replaced with a question mark.

This function was introduced in Qt 4.8.

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

Returns a copy of the string reference as a QString object.

Calls C++ function: QString QStringRef::toString() const.

Returns a copy of the string reference as a QString object.

If the string reference is not a complete reference of the string (meaning that position() is 0 and size() equals string()->size()), this function will allocate a new string to return.

See also string().

pub unsafe fn to_u_int_2a(&self, ok: *mut bool, base: c_int) -> c_uint

Returns the string converted to an unsigned int using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: unsigned int QStringRef::toUInt(bool* ok = …, int base = …) const.

Returns the string converted to an unsigned int using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toUInt()

This function was introduced in Qt 5.1.

See also QString::toUInt().

pub unsafe fn to_u_int_1a(&self, ok: *mut bool) -> c_uint

Returns the string converted to an unsigned int using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: unsigned int QStringRef::toUInt(bool* ok = …) const.

Returns the string converted to an unsigned int using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toUInt()

This function was introduced in Qt 5.1.

See also QString::toUInt().

pub unsafe fn to_u_int_0a(&self) -> c_uint

Returns the string converted to an unsigned int using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: unsigned int QStringRef::toUInt() const.

Returns the string converted to an unsigned int using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toUInt()

This function was introduced in Qt 5.1.

See also QString::toUInt().

pub unsafe fn to_u_long_2a(&self, ok: *mut bool, base: c_int) -> c_ulong

Returns the string converted to an unsigned long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: unsigned long QStringRef::toULong(bool* ok = …, int base = …) const.

Returns the string converted to an unsigned long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toULongLong()

This function was introduced in Qt 5.1.

See also QString::toULong().

pub unsafe fn to_u_long_1a(&self, ok: *mut bool) -> c_ulong

Returns the string converted to an unsigned long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: unsigned long QStringRef::toULong(bool* ok = …) const.

Returns the string converted to an unsigned long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toULongLong()

This function was introduced in Qt 5.1.

See also QString::toULong().

pub unsafe fn to_u_long_0a(&self) -> c_ulong

Returns the string converted to an unsigned long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: unsigned long QStringRef::toULong() const.

Returns the string converted to an unsigned long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toULongLong()

This function was introduced in Qt 5.1.

See also QString::toULong().

pub unsafe fn to_u_long_long_2a(&self, ok: *mut bool, base: c_int) -> u64

Returns the string converted to an unsigned long long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: qulonglong QStringRef::toULongLong(bool* ok = …, int base = …) const.

Returns the string converted to an unsigned long long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toULongLong()

This function was introduced in Qt 5.1.

See also QString::toULongLong().

pub unsafe fn to_u_long_long_1a(&self, ok: *mut bool) -> u64

Returns the string converted to an unsigned long long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: qulonglong QStringRef::toULongLong(bool* ok = …) const.

Returns the string converted to an unsigned long long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toULongLong()

This function was introduced in Qt 5.1.

See also QString::toULongLong().

pub unsafe fn to_u_long_long_0a(&self) -> u64

Returns the string converted to an unsigned long long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: qulonglong QStringRef::toULongLong() const.

Returns the string converted to an unsigned long long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toULongLong()

This function was introduced in Qt 5.1.

See also QString::toULongLong().

pub unsafe fn to_u_short_2a(&self, ok: *mut bool, base: c_int) -> c_ushort

Returns the string converted to an unsigned short using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: unsigned short QStringRef::toUShort(bool* ok = …, int base = …) const.

Returns the string converted to an unsigned short using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toUShort()

This function was introduced in Qt 5.1.

See also QString::toUShort().

pub unsafe fn to_u_short_1a(&self, ok: *mut bool) -> c_ushort

Returns the string converted to an unsigned short using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: unsigned short QStringRef::toUShort(bool* ok = …) const.

Returns the string converted to an unsigned short using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toUShort()

This function was introduced in Qt 5.1.

See also QString::toUShort().

pub unsafe fn to_u_short_0a(&self) -> c_ushort

Returns the string converted to an unsigned short using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

Calls C++ function: unsigned short QStringRef::toUShort() const.

Returns the string converted to an unsigned short using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

The string conversion will always happen in the 'C' locale. For locale dependent conversion use QLocale::toUShort()

This function was introduced in Qt 5.1.

See also QString::toUShort().

pub unsafe fn to_ucs4(&self) -> CppBox<QVectorOfUint>

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

Calls C++ function: QVector<unsigned int> QStringRef::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's replacement character (QChar::ReplacementCharacter, which corresponds to U+FFFD).

The returned vector is not NUL terminated.

This function was introduced in Qt 4.8.

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

Returns a Unicode representation of the string reference. Since the data stems directly from the referenced string, it is not null-terminated unless the string reference includes the string's null terminator.

Calls C++ function: const QChar* QStringRef::unicode() const.

Returns a Unicode representation of the string reference. Since the data stems directly from the referenced string, it is not null-terminated unless the string reference includes the string’s null terminator.

See also string().

Trait Implementations§

unsafe fn delete(&self)

Destroys the string reference.

Calls C++ function: [destructor] void QStringRef::~QStringRef().

Destroys the string reference.

Since this class is only used to refer to string data, and does not take ownership of it, no memory is freed when instances are destroyed.

impl Data for QStringRef

unsafe fn data(&self) -> Ptr<QChar>

Same as unicode().

Calls C++ function: const QChar* QStringRef::data() const.

Same as unicode().

§

type Output = Ptr<QChar>

Return type of data() function.

impl End for QStringRef

unsafe fn end(&self) -> Ptr<QChar>

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

Calls C++ function: const QChar* QStringRef::end() const.

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

This function was introduced in Qt 5.4.

See also cbegin(), constBegin(), end(), constEnd(), rbegin(), and rend().

§

type Output = Ptr<QChar>

Output type.

impl Ge<*const i8> for QStringRef

unsafe fn ge(&self, s: &*const c_char) -> bool

This function overloads operator>=().

Calls C++ function: bool QStringRef::operator>=(const char* s) const.

This function overloads operator>=().

This function overloads operator>().

Calls C++ function: bool QStringRef::operator>(const char* s) const.

This function overloads operator>().

The s const char pointer is converted to a QStringRef using the fromUtf8() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

Returns true if this string is lexically greater than the parameter string s. Otherwise returns false.

This function overloads operator<=().

Calls C++ function: bool QStringRef::operator<=(const char* s) const.

This function overloads operator<=().

This function overloads operator<().

Calls C++ function: bool QStringRef::operator<(const char* s) const.