Namespaces
Variants

std:: basic_streambuf

From cppreference.net
< cpp ‎ | io
定义于头文件 <streambuf>
template <

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

> class basic_streambuf ;

basic_streambuf 控制字符序列的输入和输出。它包含并提供对以下内容的访问

  1. 受控字符序列 ,亦称 缓冲区 ,可能包含用于缓冲输入操作的 输入序列 (亦称 获取区 )和/或用于缓冲输出操作的 输出序列 (亦称 放置区 )。
  2. 关联字符序列 ,亦称 (用于输入)或 (用于输出)。这可能是通过操作系统API访问的实体(文件、TCP套接字、串行端口、其他字符设备),也可能是可解释为字符源或汇的对象( std::vector 数组 字符串字面量 )。

I/O流对象 std::basic_istream std::basic_ostream ,以及所有从它们派生的对象( std::ofstream std::stringstream 等),都是完全基于 std::basic_streambuf 实现的。

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

  1. beginning指针 始终指向缓冲区的最低地址元素。
  2. next指针 指向下一个待读取或写入的候选元素。
  3. end指针 指向缓冲区末尾之后的位置。

一个 basic_streambuf 对象可能支持输入(此时由起始指针、下一个指针和结束指针描述的缓冲区称为 get area )、输出( put area ),或同时支持输入和输出。在后一种情况下,会跟踪六个指针,这些指针可能全部指向同一字符数组的元素,也可能指向两个独立的数组。

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

如果获取区域中的下一个指针小于结束指针,则表示存在 读取位置 。可以解引用下一个指针并进行读取操作。

如果在获取区域中下一个指针大于起始指针,则存在 putback position (回退位置),此时可以递减下一个指针、解引用并赋值,从而将字符放回获取区域。

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

std::basic_streambuf 基类的典型实现仅包含六个 CharT* 指针和一个 std::locale 副本作为数据成员。此外,实现可能保留本地化刻面的缓存副本,这些缓存在调用 imbue() 时会被置为无效。具体缓冲区如 std::basic_filebuf std::basic_stringbuf 均派生自 std::basic_streambuf

std-streambuf.svg

提供了几种常见字符类型的类型定义:

定义于头文件 <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 ( )
(公开成员函数)
Putback
将单个字符放回输入序列
(公开成员函数)
将输入序列中的下一个指针向后移动一位
(公开成员函数)

受保护的成员函数

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

另请参阅

对象类型,能够保存控制C语言I/O流所需的所有信息
(类型定义)