std::basic_stringbuf<CharT,Traits,Allocator>::str

	(1)
std::basic_string<CharT, Traits, Allocator> str() const;		(до C++20)
std::basic_string<CharT, Traits, Allocator> str() const&;		(с C++20)
template<class SAlloc> std::basic_string<CharT, Traits, SAlloc> str( const SAlloc& a ) const;	(2)	(с C++20)
std::basic_string<CharT, Traits, Allocator> str() &&;	(3)	(с C++20)
void str( const std::basic_string<CharT, Traits, Allocator>& s );	(4)
template<class SAlloc> void str( const std::basic_string<CharT, Traits, SAlloc>& s );	(5)	(с C++20)
void str( std::basic_string<CharT, Traits, Allocator>&& s );	(6)	(с C++20)
template< class StringViewLike > void str( const StringViewLike& t );	(7)	(с C++26)

Получает и устанавливает базовую строку.

В описаниях ниже buf и mode являются экспозиционными данными *this.

1) Создаёт и возвращает объект std::basic_string, содержащий копию последовательности символов данного std::basic_stringbuf. Для потоков только для чтения возвращаемая строка содержит символы из диапазона [eback(), egptr()). Для потоков чтения/записи или только для записи, она содержит символы с pbase() до последнего символа последовательности независимо от egptr() и epptr().

Последовательность символов в буфере, открытом для записи, может быть перевыделена для повышения эффективности. В этом случае возвращаются только инициализированные символы: это символы, полученные из аргумента строки конструктора, аргумента строки последнего вызова перегрузки с установкой для str(), или из операции записи. Типичная реализация, использующая перевыделение, сохраняет указатель на верхнюю границу, чтобы отслеживать конец инициализированной части буфера, а эта перегрузка возвращает символы с pbase() до указателя верхней границы.

Эквивалентно return std::basic_string<CharT, Traits, Allocator>(view(), get_allocator());. (с C++20)

2) Аналогично (1), за исключением того, что для построения возвращаемого std::basic_string используется a. Эквивалентно return std::basic_string<CharT, Traits, SAlloc>(view(), a);.

Эта перегрузка участвует в разрешении перегрузки только если SAlloc удовлетворяет требованиям Allocator.

3) Создаёт объект std::basic_string так, как если бы он был сдвинуто скопирован из последовательности символов *this в buf. buf может потребоваться скорректировать, чтобы содержать то же содержимое, что и в (1) сначала. После этого устанавливает buf в пустое значение и вызывает init_buf_ptrs(), затем возвращает объект std::basic_string.

4) Заменяет базовую последовательность символов так, как если бы это было сделано с помощью buf = s, затем вызывает init_buf_ptrs().

5) Аналогично (4), за исключением того, что тип аллокатора s не Allocator.

Эта перегрузка участвует в разрешении перегрузки только если std::is_same_v<SAlloc, Allocator> является false.

6) Заменяет базовую последовательность символов, как если бы это было сделано с помощью buf = std::move(s), затем вызывает init_buf_ptrs().

7) Неявно преобразует t в представление строки sv так, как если бы это было сделано с помощью std::basic_string_view<CharT, Traits> sv = t;, затем заменяет базовую последовательность символов, как если бы это было сделано с помощью buf = sv, затем вызывает init_buf_ptrs().

Эта перегрузка участвует в разрешении перегрузки только если

std::is_convertible_v<const StringViewLike&,
 std::basic_string_view<CharT, Traits>>

является true.

Параметры

s	-	объект `std::basic_string`, содержащий заменяемую последовательность символов
t	-	объект (преобразуемый в `std::basic_string_view`), содержащий заменяемую последовательность символов
a	-	аллокатор, используемый для всех выделений памяти возвращаемого `std::basic_string`

Возвращаемое значение

1-3) Объект std::basic_string, содержащий базовую последовательность символов данного буфера.

4-7) (ничего)

Примечания

К этой функции обычно обращаются через std::basic_istringstream::str(), std::basic_ostringstream::str() или std::basic_stringstream::str().

Макрос проверки возможности использования функции	Значение	Стандарт	Функция
`__cpp_lib_sstream_from_string_view`	202306L	(C++26)	Интерфейс потоков строк с `std::string_view`

Пример

#include <iostream>
#include <sstream>
 
int main()
{
    int n;
 
    std::istringstream in;  // could also use in("1 2")
    in.rdbuf()->str("1 2"); // set the get area
    in >> n;
    std::cout << "after reading the first int from \"1 2\", the int is " 
              << n << ", str() = \"" << in.rdbuf()->str() << "\"\n"; // or in.str()
 
    std::ostringstream out("1 2");
    out << 3;
    std::cout << "after writing the int '3' to output stream \"1 2\""
              << ", str() = \"" << out.str() << "\"\n";
 
    std::ostringstream ate("1 2", std::ios_base::ate); // C++11
    ate << 3;
    std::cout << "after writing the int '3' to append stream \"1 2\""
              << ", str() = \"" << ate.str() << "\"\n";
}

Вывод:

after reading the first int from "1 2", the int is 1, str() = "1 2"
after writing the int '3' to output stream "1 2", str() = "3 2"
after writing the int '3' to append stream "1 2", str() = "1 23"

Отчёты о дефектах

Следующие отчёты о дефектах, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

DR	Применено к	Поведение, опубликованное в стандарте	Корректное поведение
LWG 432	C++98	1. Перегрузка (1) не указывала содержимое базовой последовательности символов 2. Перегрузка (4) не указывала, как инициализируются последовательности ввода и вывода	Оба значения указаны
LWG 562	C++98	Перегрузка (4) устанавливала `epptr()` в указатель, находящийся на один шаг после последнего базового символа, если `bool(mode & std::ios_base::out) == true`	`epptr()` может быть установлено за пределами этой позиции

См. также

str	получает или устанавливает содержимое базового объекта устройства строки (общедоступный член-функция `std::basic_stringstream<CharT,Traits,Allocator>`)
view (C++20)	получает представление базовой последовательности символов (общедоступный член-функция)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/io/basic_stringbuf/str