std::basic_streambuf

 

C++

编译器支持

独立和宿主式

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

输入/输出库

I/O 操纵符

打印函数 (C++23)

C 风格 I/O

缓冲区

basic_streambuf

basic_filebuf

basic_stringbuf

basic_spanbuf (C++23)

strstreambuf (C++98/26*)

basic_syncbuf (C++20)

流

抽象

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

文件 I/O

basic_ifstream

basic_ofstream

basic_fstream

字符串 I/O

basic_istringstream

basic_ostringstream

basic_stringstream

数组 I/O

basic_ispanstream (C++23)

basic_ospanstream (C++23)

basic_spanstream (C++23)

istrstream (C++98/26*)

ostrstream (C++98/26*)

strstream (C++98/26*)

同步输出

basic_osyncstream (C++20)

类型

streamoff

streamsize

fpos

错误类别接口

iostream_category (C++11)

io_errc (C++11)

 

std::basic_streambuf

公共成员函数 basic_streambuf::~basic_streambuf      区域设置 basic_streambuf::pubimbue basic_streambuf::getloc 定位 basic_streambuf::pubsetbuf basic_streambuf::pubseekoff basic_streambuf::pubseekpos basic_streambuf::pubsync 获取区域 basic_streambuf::in_avail basic_streambuf::snextc basic_streambuf::sbumpc basic_streambuf::sgetc basic_streambuf::sgetn 放置区域 basic_streambuf::sputc basic_streambuf::sputn 放回 basic_streambuf::sputbackc basic_streambuf::sungetc

保护成员函数 basic_streambuf::basic_streambuf basic_streambuf::operator= (C++11) basic_streambuf::swap (C++11) 区域设置 basic_streambuf::imbue 定位 basic_streambuf::setbuf basic_streambuf::seekoff basic_streambuf::seekpos basic_streambuf::sync 获取区域 basic_streambuf::showmanyc basic_streambuf::underflow basic_streambuf::uflow basic_streambuf::xsgetn basic_streambuf::ebackbasic_streambuf::gptrbasic_streambuf::egptr basic_streambuf::gbump basic_streambuf::setg 放置区域 basic_streambuf::xsputn basic_streambuf::overflow basic_streambuf::pbasebasic_streambuf::pptrbasic_streambuf::epptr basic_streambuf::pbump basic_streambuf::setp 放回 basic_streambuf::pbackfail

 

定义于头文件 <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 本地环境 facet 来执行转换。常见的例子是通过 std::wfstream 对象访问 UTF-8（或其他多字节）文件：受控序列由 `wchar_t` 字符组成，但关联序列由字节组成。

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

提供了用于常见字符类型的几个 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

成员函数

(析构函数) [virtual]	析构 `basic_streambuf` 对象 (virtual public member function)
区域设置
pubimbue	更改关联的区域设置并调用 imbue() (public member function)
getloc	获取关联区域设置的副本 (public member function)
定位
pubsetbuf	调用 setbuf() (public member function)
pubseekoff	调用 seekoff() (public member function)
pubseekpos	调用 seekpos() (public member function)
pubsync	调用 sync() (public member function)
获取区域
in_avail	获取在获取区域中立即可用的字符数 (public member function)
snextc	推进输入序列，然后读取一个字符而不再次推进 (public member function)
sbumpcstossc (removed in C++17)	从输入序列读取一个字符并推进序列 (public member function)
sgetc	从输入序列读取一个字符而不推进序列 (public member function)
sgetn	调用 xsgetn() (public member function)
放置区域
sputc	向放置区域写入一个字符并推进下一个指针 (public member function)
sputn	调用 xsputn() (public member function)
放回
sputbackc	将一个字符放回输入序列中 (public member function)
sungetc	将输入序列中的下一个指针向后移动一位 (public member function)
保护成员函数
(构造函数)	构造一个 `basic_streambuf` 对象 (protected member function)
operator= (C++11)	替换一个 `basic_streambuf` 对象 (protected member function)
swap (C++11)	交换两个 `basic_streambuf` 对象 (protected member function)
区域设置
imbue [virtual]	对关联区域设置的更改做出反应 (virtual protected member function)
定位
setbuf [virtual]	如果允许，则用用户定义的数组替换缓冲区 (virtual protected member function)
seekoff [virtual]	使用相对寻址重新定位输入序列、输出序列或两者的下一个指针 (virtual protected member function)
seekpos [virtual]	使用绝对寻址重新定位输入序列、输出序列或两者的下一个指针 (virtual protected member function)
sync [virtual]	将缓冲区与关联的字符序列同步 (virtual protected member function)
获取区域
showmanyc [virtual]	如果已知，则获取关联输入序列中可用于输入的字符数 (virtual protected member function)
underflow [virtual]	从关联的输入序列读取字符到获取区域 (virtual protected member function)
uflow [virtual]	从关联的输入序列读取字符到获取区域并推进下一个指针 (virtual protected member function)
xsgetn [virtual]	从输入序列读取多个字符 (virtual protected member function)
ebackgptregptr	返回指向获取区域的起始位置、当前字符和结束位置的指针 (protected member function)
gbump	推进输入序列中的下一个指针 (protected member function)
setg	重新定位输入序列的起始位置、下一个位置和结束位置的指针 (protected member function)
放置区域
xsputn [virtual]	向输出序列写入多个字符 (virtual protected member function)
overflow [virtual]	将字符从放置区域写入到关联的输出序列 (virtual protected member function)
pbasepptrepptr	返回指向放置区域的起始位置、当前字符和结束位置的指针 (protected member function)
pbump	推进输出序列的下一个指针 (protected member function)
setp	重新定位输出序列的起始位置、下一个位置和结束位置的指针 (protected member function)
放回
pbackfail [virtual]	将一个字符放回输入序列中，可能会修改输入序列 (virtual protected member function)

参见

FILE	对象类型，能够保存控制 C 风格 I/O 流所需的所有信息 (typedef)