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.

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

Типы членов

Члены-функции

См. также