SourcePro® 2024.1 |
SourcePro® API Reference Guide |
Provides read-only access to a range of code units within a referenced RWUString. More...
#include <rw/i18n/RWUConstSubString.h>
Public Member Functions | |
RWUConstSubString (const RWUConstSubString &sp) | |
size_t | boundsCheckIndex (size_t offset) const |
const RWUChar16 * | data () const |
bool | isNull () const |
size_t | length () const |
RWUChar16 | operator() (size_t offset) const |
RWUChar16 | operator[] (size_t offset) const |
size_t | start () const |
Friends | |
class | RWUString |
class | RWUStringSearch |
RWUConstSubString allows read-only access to a range of code units within a referenced RWUString. The range is defined by a starting position and an length within the referenced string. For example, the 7th
through the 11th
elements, inclusive, would have starting position of 7
and an length of 5
.
There are no public constructors. RWUConstSubString instances are constructed by various functions of the RWUString class. Typically, substrings are created and used anonymously, then destroyed immediately.
RWUConstSubString performs bounds checking in all methods that accept an offset value. These methods throw RWBoundsErr if an offset exceeds the current bounds of the substring.
Program Output:
|
inline |
Copy constructor.
|
inline |
Returns offset.
RWBoundsErr | Thrown if self is a null substring or if offset is greater than or equal to length(). |
|
inline |
Returns a pointer to the string contents referenced by self. The storage referenced by this pointer is owned by the RWUString associated with self. This storage may not be deleted or modified. The pointer becomes invalid if the RWUString is modified or destroyed.
RWBoundsErr | Thrown if self is a null substring. |
|
inline |
Returns true
if the substring defined by self is null or empty; otherwise, false
.
|
inline |
Returns the number of code units in the substring defined by self.
|
inline |
Returns the code unit located at index offset within self. The value of offset must be less than length().
RWBoundsErr | Thrown if self is a null substring, or if offset is greater than or equal to length(). |
|
inline |
Returns the code unit located at index offset within self. The value of offset must be less than length().
RWBoundsErr | Thrown if self is a null substring, or if offset is greater than or equal to length(). |
|
inline |
|
related |
Returns true
if lhs does not have the same length as, or lexicographically differs from, rhs; otherwise, false
. This operator represents the logical negation of operator==.
|
related |
Returns true
if lhs does not have the same length as, or lexicographically differs from, rhs; otherwise, false
. This operator represents the logical negation of operator==.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs does not have the same length as, or lexicographically differs from, rhs; otherwise, false
. This operator represents the logical negation of operator==.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs does not have the same length as, or lexicographically differs from, rhs; otherwise, false
. This operator represents the logical negation of operator==.
|
related |
Returns true
if lhs does not have the same length as, or lexicographically differs from, rhs; otherwise, false
. This operator represents the logical negation of operator==.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs does not have the same length as, or lexicographically differs from, rhs; otherwise, false
. This operator represents the logical negation of operator==.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs does not have the same length as, or lexicographically differs from, rhs; otherwise, false
. Also returns false
if both substrings are invalid. This operator represents the logical negation of operator==.
|
related |
Returns true
if lhs is lexicographically less than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
|
related |
Returns true
if lhs is lexicographically less than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs is lexicographically less than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs is lexicographically less than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
|
related |
Returns true
if lhs is lexicographically less than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs is lexicographically less than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs is lexicographically less than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
|
related |
Writes the sequence of bytes to std::ostream that are produced when contents of ustr are converted into the character encoding scheme specified by the currently active target RWUFromUnicodeConversionContext.
If os.width()
is greater than the number of code points contained in the source string, the output is padded using a single space fill character (U+0020
). If os.width()
is less than the number of code points contained the source string, the entire contents of the string are inserted into the output stream. Any padding is inserted after the string if the std::ios_base::left format flag is set, or before if std::ios_base::right is set or if neither flag is set.
RWUException | Thrown to report conversion errors. |
std::ios_base::failure | Thrown to report any errors detected while performing stream operations. |
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
. Returns true
if both substrings are null. If the two strings are identical over the length of the shortest string, then the shorter string is considered less than the longer string.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs has the same length and is lexicographically identical to rhs; otherwise, false
.
|
related |
Returns true
if lhs is lexicographically greater than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
|
related |
Returns true
if lhs is lexicographically greater than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs is lexicographically greater than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs is lexicographically greater than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
|
related |
Returns true
if lhs is lexicographically greater than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs is lexicographically greater than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs is lexicographically greater than rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
|
related |
Returns true
if lhs is lexicographically greater than or equal to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
|
related |
Returns true
if lhs is lexicographically greater than or equal to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs is lexicographically greater than or equal to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs is lexicographically greater than or equal to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
|
related |
Returns true
if lhs is lexicographically greater than or equal to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.
|
related |
Returns true
if lhs is lexicographically greater than or equal to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.
|
related |
Returns true
if lhs is lexicographically greater than or equal to rhs; otherwise, false
. If the two strings are identical over the length of the shortest string, then the longer string is considered greater than the shorter string.
Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |