std::basic_streambuf

template< 
    class CharT, 
    class Traits = std::char_traits<CharT>
> class basic_streambuf;

Класс basic_streambuf управляет вводом и выводом символьной последовательности. Он включает в себя и предоставляет доступ к

1. управляемой символьной последовательности, также называемой буфером, которая может содержать входную последовательность (также называемую областью чтения) для буферизации операций ввода и/или выходную последовательность (также называемую областью записи) для буферизации операций вывода.
2. связанной символьной последовательности, также называемой источником (для ввода) или приёмником (для вывода). Это может быть сущность, доступ к которой осуществляется через API ОС (файл, TCP-сокет, последовательный порт или другое символьное устройство), либо объект (std::vector, массив, строковый литерал), который можно интерпретировать как источник или приёмник символов.

Объекты потоков ввода-вывода std::basic_istream и std::basic_ostream, а также все производные от них объекты (std::ofstream, std::stringstream и т. д.), реализованы полностью на основе std::basic_streambuf.

Управляемая символьная последовательность представляет собой массив из CharT, который постоянно отображает подпоследовательность или «окно» в связанную символьную последовательность. Его состояние описывается тремя указателями:

1. Указатель на начало всегда указывает на наименьший элемент буфера.
2. Следующий указатель указывает на элемент, который будет следующим кандидатом для чтения или записи.
3. Указатель на конец указывает на позицию сразу за концом буфера.

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

Если следующий указатель в области записи меньше указателя на конец, доступна позиция записи. По следующему указателю можно разыменовывать и присваивать значение.

Если следующий указатель в области чтения меньше указателя на конец, доступна позиция чтения. По следующему указателю можно разыменовывать и считывать значение.

Если следующий указатель в области чтения больше указателя на начало, доступна позиция возврата; следующий указатель можно уменьшить, разыменовать и присвоить ему значение, чтобы вернуть символ в область чтения.

Представление и кодировка символов в управляемой последовательности могут отличаться от представления символов в связанной последовательности. В этом случае для преобразования обычно используется фасет локали std::codecvt. Типичный пример — файлы UTF-8 (или файлы с другой многобайтовой кодировкой), доступ к которым осуществляется через объекты std::wfstream: управляемая последовательность состоит из символов wchar_t, а связанная последовательность — из байтов.

Типичная реализация базового класса std::basic_streambuf содержит в качестве полей данных только шесть указателей CharT* и копию std::locale. Кроме того, реализации могут хранить кэшированные копии фасетов локали, которые становятся недействительными при каждом вызове imbue(). Конкретные буферы, такие как std::basic_filebuf или std::basic_stringbuf, являются производными от std::basic_streambuf.

Предусмотрено несколько псевдонимов типов для распространённых символьных типов:

Типы-члены

Функции-члены

См. также