命名空间
变体
操作

std::basic_streambuf

来自 cppreference.cn
< cpp‎ | io
 
C++
 
输入/输出库
 
std::basic_streambuf
 
定义于头文件 <streambuf>
template<

    class CharT,
    class Traits = std::char_traits<CharT>

> class basic_streambuf;

basic_streambuf 类控制字符序列的输入和输出。它包含并提供访问：

  1. 受控字符序列，也称为缓冲区，其中可能包含用于缓冲输入操作的输入序列（也称为获取区）和/或用于缓冲输出操作的输出序列（也称为放置区）。
  2. 关联字符序列，也称为源（用于输入）或接收器（用于输出）。这可以是通过操作系统 API 访问的实体（文件、TCP 套接字、串行端口、其他字符设备），也可以是可解释为字符源或接收器的对象（std::vector、array、string literal）。

I/O 流对象 std::basic_istream 和 std::basic_ostream，以及所有派生自它们的类（std::ofstream、std::stringstream 等），都是完全基于 std::basic_streambuf 实现的。

受控字符序列是一个 CharT 数组，它始终表示关联字符序列的子序列或“窗口”。其状态由三个指针描述：

  1. 起始指针，始终指向缓冲区的最低元素。
  2. 下一个指针，指向作为下一个读写候选的元素。
  3. 结束指针，指向缓冲区末尾之后一个位置。

basic_streambuf 对象可能支持输入（此时由起始指针、下一个指针和结束指针描述的缓冲区称为获取区）、输出（放置区），或者同时支持输入和输出。在后一种情况下，跟踪六个指针，它们可能都指向同一个字符数组的元素，或者指向两个独立的数组。

如果放置区中下一个指针小于结束指针，则存在一个可用的写入位置。下一个指针可以被解引用并赋值。

如果获取区中下一个指针小于结束指针，则存在一个可用的读取位置。下一个指针可以被解引用并读取。

如果获取区中下一个指针大于起始指针，则存在一个可用的回推位置，并且下一个指针可以递减、解引用并赋值，以便将字符回推到获取区。

受控序列中的字符表示和编码可能与关联序列中的字符表示不同，在这种情况下，通常使用 std::codecvt locale facet 来执行转换。常见的例子是通过 std::wfstream 对象访问的 UTF-8（或其他多字节）文件：受控序列由 wchar_t 字符组成，但关联序列由字节组成。

std::basic_streambuf 基类的典型实现只包含六个 CharT* 指针和一份 std::locale 作为数据成员。此外，实现可能保留 locale facet 的缓存副本，这些副本在调用 imbue() 时会失效。具体缓冲区，如 std::basic_filebuf 或 std::basic_stringbuf，都派生自 std::basic_streambuf。

std-streambuf.svg

提供了用于常见字符类型的几个 typedef

定义于头文件 <streambuf>
类型 定义
std::streambuf std::basic_streambuf<char>
std::wstreambuf std::basic_streambuf<wchar_t>

目录

[编辑] 成员类型

成员类型 定义
char_type CharT[编辑]
traits_type Traits；如果 Traits::char_type 不是 CharT，则程序格式不正确。[编辑]
int_type Traits::int_type[编辑]
pos_type Traits::pos_type[编辑]
off_type Traits::off_type[编辑]

[编辑] 成员函数

[虚拟]
 销毁 basic_streambuf 对象
(虚公共成员函数) [编辑]
区域设置
 更改关联的区域设置并调用 imbue()
(公共成员函数) [编辑]
 获取关联区域设置的副本
(公共成员函数) [编辑]
定位
 调用 setbuf()
(公共成员函数) [编辑]
 调用 seekoff()
(公共成员函数) [编辑]
 调用 seekpos()
(公共成员函数) [编辑]
 调用 sync()
(公共成员函数) [编辑]
获取区
 获取获取区中立即可用的字符数
(公共成员函数) [编辑]
 推进输入序列，然后读取一个字符而不再次推进
(公共成员函数) [编辑]
(C++17 中移除)
 从输入序列中读取一个字符并推进序列
(公共成员函数) [编辑]
 从输入序列中读取一个字符而不推进序列
(公共成员函数) [编辑]
 调用 xsgetn()
(公共成员函数) [编辑]
放置区
 将一个字符写入放置区并推进下一个指针
(公共成员函数) [编辑]
 调用 xsputn()
(公共成员函数) [编辑]
回放
 将一个字符放回输入序列
(公共成员函数) [编辑]
 将输入序列中的下一个指针后退一个位置
(公共成员函数) [编辑]

受保护的成员函数

 构造 basic_streambuf 对象
(受保护成员函数) [编辑]
(C++11)
 替换 basic_streambuf 对象
(受保护成员函数) [编辑]
(C++11)
 交换两个 basic_streambuf 对象
(受保护成员函数) [编辑]
区域设置
[虚拟]
 响应关联区域设置的更改
(虚受保护成员函数) [编辑]
定位
[虚拟]
 如果允许，用用户定义的数组替换缓冲区
(虚受保护成员函数) [编辑]
[虚拟]
 使用相对寻址重新定位输入序列、输出序列或两者的下一个指针
(虚受保护成员函数) [编辑]
[虚拟]
 使用绝对寻址重新定位输入序列、输出序列或两者的下一个指针
(虚受保护成员函数) [编辑]
[虚拟]
 将缓冲区与关联的字符序列同步
(虚受保护成员函数) [编辑]
获取区
[虚拟]
 如果已知，获取关联输入序列中可用于输入的字符数
(虚受保护成员函数) [编辑]
[虚拟]
 从关联输入序列中读取字符到获取区
(虚受保护成员函数) [编辑]
[虚拟]
 从关联输入序列中读取字符到获取区并推进下一个指针
(虚受保护成员函数) [编辑]
[虚拟]
 从输入序列中读取多个字符
(虚受保护成员函数) [编辑]
 返回获取区起始、当前字符和结尾的指针
(受保护成员函数) [编辑]
 推进输入序列中的下一个指针
(受保护成员函数) [编辑]
 重新定位输入序列的起始、下一个和结束指针
(受保护成员函数) [编辑]
放置区
[虚拟]
 向输出序列写入多个字符
(虚受保护成员函数) [编辑]
[虚拟]
 从放置区向关联输出序列写入字符
(虚受保护成员函数) [编辑]
 返回放置区起始、当前字符和结尾的指针
(受保护成员函数) [编辑]
 推进输出序列的下一个指针
(受保护成员函数) [编辑]
 重新定位输出序列的起始、下一个和结束指针
(受保护成员函数) [编辑]
回放
[虚拟]
 将一个字符放回输入序列，可能会修改输入序列
(虚受保护成员函数) [编辑]

[编辑] 另请参阅

 对象类型，能够保存控制 C I/O 流所需的所有信息
(类型定义) [编辑]
取自 "https://cppreference.cn/mwiki/index.php?title=cpp/io/basic_streambuf&oldid=165210"