BloombergLP::bslstl::StringRefImp

This class provides a reference-semantic-like (see below) mechanism that allows const std::string values, which are represented externally as either an std::string or null-terminated c-style string (or parts thereof), to be treated both uniformly and efficiently when passed as an argument to a function in which the string's length will be needed. The interface of this class provides a subset of accessor methods found on std::string (but none of the manipulators) -- all of which apply to the referenced string. But, because only non-modifiable access is afforded to the referenced string value, each of the manipulators on this type -- assignment in particular -- apply to this string-reference object itself (as if it had pointer semantics). Hence, this class has a hybrid of reference- and pointer-semantics.

Synopsis

Declared in <bslstl_stringref.h>

template<class CHAR_TYPE>
class StringRefImp
    : public StringRefData<CHAR_TYPE>

Description

This class: * supports a complete set of value-semantic operations

  • except for bdex serialization * is exception-neutral (agnostic) * is alias-safe * is const thread-safe For terminology see bsldoc_glossary.

Base Classes

NameDescription
StringRefData<CHAR_TYPE>This class is an intermediate link between bslstl::StringRef used in BDE and bsl::string_view and is kept only for compatibility with legacy code.

Type Aliases

NameDescription
const_iterator Alias for a constant iterator over the characters of this ref.
const_reference This typedef is an alias to reference.
const_reverse_iterator This typedef is an alias to bsl::reverse_iterator<const_iterator>.
difference_type This typedef is an alias to std::ptrdiff_t.
iterator This typedef is an alias to value_type const *.
reference This typedef is an alias to value_type const&.
size_type Standard Library general container requirements.
value_type Alias for a constant character type stored in this string ref.

Member Functions

NameDescription
StringRefImp [constructor]Constructors
assign assign overloads
begin Return an STL-compatible iterator to the first character of the string bound to this string reference or end() if the string reference is empty. The iterator remains valid as long as this object is valid and is bound to the same string.
compare Compare this and the specified other string objects using a lexicographical comparison and return a negative value if this string is less than other string, a positive value if this string is greater than other string, and 0 if this string is equal to other string.
data Return the address of the first character of the string bound to this string reference such that [data() .. data()+length())] is a valid half-open range of characters. Note that the range of characters might not be null-terminated and may contain embedded null characters.
empty Return true if this object represents an empty string value, and false otherwise. This object represents an empty string value if begin() == end(). Note that this method is functionally identical with the isEmpty method and allows developers to avoid distracting syntax differences when StringRef appears in juxtaposition with string, which defines empty but not isEmpty.
end Return an STL-compatible iterator one-past-the-last character of the string bound to this string reference or begin() if the string reference is empty. The iterator remains valid as long as this object is valid and is bound to the same string.
isEmpty Return true if this object represents an empty string value, and false otherwise. This object represents an empty string value if begin() == end().
length Return the length of the string referred to by this object. Note that this call is equivalent to end() - begin().
operator[] Return a reference providing a non-modifiable access to the character at the specified index in the string bound to this reference. This reference remains valid as long as the string currently bound to this object remains valid. The behavior is undefined unless 0 <= index < length().
rbegin Return an STL-compatible reverse iterator to the last character of the string bound to this string reference or rend() if the string reference is empty. The iterator remains valid as long as this object is valid and is bound to the same string.
rend Return an STL-compatible reverse iterator to the prior-to-the-beginning character of the string bound to this string reference or rbegin() if the string reference is empty. The iterator remains valid as long as this object is valid and is bound to the same string.
reset Reset this string reference to the default-constructed state having an empty std::string value and the following attribute values: ` begin() == end() isEmpty() == true `
size Return the number of characters in the string referred to by this object. Note that this call is equivalent to end() - begin().
operator BloombergLP::bslmf::NestedTraitDeclaration<StringRefData, is_trivially_copyable> Declare StringRefData as trivially copyable.
operator BloombergLP::bslmf::NestedTraitDeclaration<StringRefImp, is_trivially_copyable> Nested trait declaration for bsl::is_trivially_copyable.
operator std::basic_string<CHAR_TYPE> Return an std::basic_string (synonymous with std::basic_string) having the value of the string bound to this string reference.

Static Member Functions

NameDescription
cStringLength Return the number of CHAR_TYPE characters in the specified null-terminated data string, up to but not including the terminal null value.

Specializations

Name
StringRefImp<char>
StringRefImp<wchar_t>

Non-Member Functions

NameDescription
operator+Return the concatenation of the specified lhs string ref and the specified rhs std::basic_string value.
operator+Return a bsl::string having the value of the concatenation of the strings referred to by the specified lhs and rhs values.
operator+Return the concatenation of the specified lhs string ref and the specified rhs bsl::basic_string value.
operator+Return the concatenation of the specified string ref and C string.