std::basic_streambuf

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (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，字符串字面量），可以解释为字符源或接收器。

I/O 流对象 std::basic_istream 和 std::basic_ostream，以及所有从它们派生的对象（std::ofstream，std::stringstream 等），完全用 std::basic_streambuf 实现。

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

1. 起始指针，始终指向缓冲区中最低的元素。
2. 下一个指针，指向下一个要读取或写入的元素。
3. 结束指针，指向缓冲区末尾的下一个元素。

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

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

如果下一个指针小于获取区域中的结束指针，则读取位置可用。可以取消引用下一个指针并从中读取。

如果下一个指针大于获取区域中的起始指针，则回退位置可用，并且可以递减下一个指针，取消引用它并对其进行赋值，以便将字符回退到获取区域。

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

std::basic_streambuf 基类的典型实现仅包含六个 CharT* 指针和 std::locale 的副本作为数据成员。此外，实现可能保留区域设置构面的缓存副本，这些副本会在每次调用 imbue() 时失效。具体的缓冲区，例如 std::basic_filebuf 或 std::basic_stringbuf，是从 std::basic_streambuf 派生的。

提供了一些用于常见字符类型的类型定义：

在头文件 <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 对象 (虚拟公共成员函数)
区域设置
pubimbue	调用 imbue() (公共成员函数)
getloc	获取关联区域设置的副本 (公共成员函数)
定位
pubsetbuf	调用 setbuf() (公共成员函数)
pubseekoff	调用 seekoff() (公有成员函数)
pubseekpos	调用 seekpos() (公有成员函数)
pubsync	调用 sync() (公有成员函数)
获取区域
in_avail	获取 get 区域中立即可用的字符数量 (公有成员函数)
snextc	推进输入序列，然后读取一个字符而不再次推进 (公有成员函数)
sbumpcstossc (C++17 中已移除)	从输入序列中读取一个字符并推进序列 (公有成员函数)
sgetc	从输入序列中读取一个字符，而不推进序列 (公有成员函数)
sgetn	调用 xsgetn() (公有成员函数)
放置区域
sputc	将一个字符写入 put 区域并推进下一个指针 (公有成员函数)
sputn	调用 xsputn() (公有成员函数)
回退
sputbackc	将一个字符放回输入序列 (公有成员函数)
sungetc	将输入序列中的下一个指针向后移动一个位置 (公有成员函数)
受保护的成员函数
(构造函数)	构造 basic_streambuf 对象 (受保护成员函数)
operator= (C++11)	替换 basic_streambuf 对象 (受保护成员函数)
swap (C++11)	交换两个 basic_streambuf 对象 (受保护成员函数)
区域设置
imbue [虚拟]	更改关联的区域设置 (虚拟受保护成员函数)
定位
setbuf [虚拟]	如果允许，用用户定义的数组替换缓冲区 (虚拟受保护成员函数)
seekoff [虚拟]	使用相对寻址重新定位输入序列、输出序列或二者的下一个指针 (虚拟受保护成员函数)
seekpos [虚拟]	使用绝对寻址重新定位输入序列、输出序列或二者的下一个指针 (虚拟受保护成员函数)
sync [虚拟]	将缓冲区与关联的字符序列同步 (虚拟受保护成员函数)
获取区域
showmanyc [虚拟]	获取关联的输入序列中可用于输入的字符数量（如果已知） (虚拟受保护成员函数)
underflow [虚拟]	从关联的输入序列读取字符到 get 区域 (虚拟受保护成员函数)
uflow [虚拟]	从关联的输入序列读取字符到 get 区域并推进下一个指针 (虚拟受保护成员函数)
xsgetn [虚拟]	从输入序列中读取多个字符 (虚拟受保护成员函数)
ebackgptregptr	返回指向 get 区域的开头、当前字符和结尾的指针 (受保护成员函数)
gbump	推进输入序列中的下一个指针 (受保护成员函数)
setg	重新定位输入序列的开头、下一个和结尾指针 (受保护成员函数)
放置区域
xsputn [虚拟]	将多个字符写入输出序列 (虚拟受保护成员函数)
overflow [虚拟]	从 put 区域将字符写入关联的输出序列 (虚拟受保护成员函数)
pbasepptrepptr	返回指向 put 区域的开头、当前字符和结尾的指针 (受保护成员函数)
pbump	推进输出序列的下一个指针 (受保护成员函数)
setp	重新定位输出序列的开头、下一个和结尾指针 (受保护成员函数)
回退
pbackfail [虚拟]	将一个字符放回输入序列，可能修改输入序列 (虚拟受保护成员函数)

另请参阅

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