std::basic_filebuf

 

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_filebuf

公共成员函数

basic_filebuf::basic_filebuf

basic_filebuf::~basic_filebuf

basic_filebuf::operator= (C++11)

basic_filebuf::swap (C++11)

basic_filebuf::native_handle (C++26)

basic_filebuf::is_open

basic_filebuf::open

basic_filebuf::close

受保护的成员函数

basic_filebuf::showmanyc

basic_filebuf::underflow

basic_filebuf::uflow

basic_filebuf::pbackfail

basic_filebuf::overflow

basic_filebuf::setbuf

basic_filebuf::seekoff

basic_filebuf::seekpos

basic_filebuf::sync

basic_filebuf::imbue

非成员函数

swap(std::basic_filebuf) (C++11)

 

定义于头文件 <fstream>
template<     class CharT,     class Traits = std::char_traits<CharT> > class basic_filebuf : public std::basic_streambuf<CharT, Traits>

std::basic_filebuf 是一个 std::basic_streambuf，其关联的字符序列是一个文件。输入序列和输出序列都与同一个文件关联，并且为两个操作维护一个共同的文件位置。使用 std::basic_filebuf 读取和写入序列的限制与 std::FILE 相同。

函数 underflow() 和 overflow() / sync() 执行文件与缓冲区的 get 和 put 区域之间的实际 I/O。当 CharT 不是 char 时，大多数实现将多字节字符存储在文件中，并且使用 std::codecvt facet 来执行宽/多字节字符转换。

提供了几种常见字符类型的 typedef

定义于头文件 <fstream>
类型	定义
std::filebuf	std::basic_filebuf<char>
std::wfilebuf	std::basic_filebuf<wchar_t>

成员类型

类型	定义
char_type	CharT
traits_type	Traits; 如果 Traits::char_type 不是 CharT，则程序是非良构的。
int_type	Traits::int_type
pos_type	Traits::pos_type，它需要是 std::fpos<Traits::state_type>
off_type	Traits::off_type
native_handle_type(C++26)	实现定义 类型，它是 可平凡复制 且 semiregular

成员函数

公共成员函数
(构造函数)	构造一个 basic_filebuf 对象 (公共成员函数)
operator= (C++11)	赋值一个 basic_filebuf 对象 (公共成员函数)
swap (C++11)	交换两个 basic_filebuf 对象 (公共成员函数)
native_handle (C++26)	返回底层实现定义的句柄 (公共成员函数)
(析构函数) [虚函数]	析构一个 basic_filebuf 对象，并在文件打开时关闭它 (虚公共成员函数)
is_open	检查关联的文件是否打开 (公共成员函数)
open	打开一个文件并将其配置为关联的字符序列 (公共成员函数)
close	刷新放置区域缓冲区并关闭关联的文件 (公共成员函数)
受保护的成员函数
showmanyc [虚函数]	可选地提供可从文件输入的字符数 (虚保护成员函数)
underflow [虚函数]	从关联的文件读取 (虚保护成员函数)
uflow [虚函数]	从关联的文件读取并推进获取区域中的下一个指针 (虚保护成员函数)
pbackfail [虚函数]	备份输入序列以取消获取一个字符，不影响关联的文件 (虚保护成员函数)
overflow [虚函数]	将字符从放置区域写入到关联的文件 (虚保护成员函数)
setbuf [虚函数]	提供用户提供的缓冲区或将此 filebuf 设置为无缓冲 (虚保护成员函数)
seekoff [虚函数]	使用相对寻址重新定位文件位置 (虚保护成员函数)
seekpos [虚函数]	使用绝对寻址重新定位文件位置 (虚保护成员函数)
sync [虚函数]	将字符从放置区域写入到关联的文件 (虚保护成员函数)
imbue [虚函数]	更改关联的区域设置 (虚保护成员函数)

非成员函数

std::swap(std::basic_filebuf) (C++11)

特化 std::swap 算法 (函数模板)

继承自 std::basic_streambuf

成员类型

成员类型	定义
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 对象 (std::basic_streambuf<CharT,Traits> 的虚公共成员函数)
区域设置
pubimbue	更改关联的区域设置并调用 imbue() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
getloc	获取关联区域设置的副本 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
定位
pubsetbuf	调用 setbuf() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
pubseekoff	调用 seekoff() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
pubseekpos	调用 seekpos() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
pubsync	调用 sync() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
获取区域
in_avail	获取获取区域中立即可用的字符数 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
snextc	推进输入序列，然后读取一个字符而不再次推进 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
sbumpcstossc (在 C++17 中移除)	从输入序列读取一个字符并推进序列 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
sgetc	从输入序列读取一个字符，而不推进序列 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
sgetn	调用 xsgetn() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
放置区域
sputc	将一个字符写入放置区域并推进下一个指针 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
sputn	调用 xsputn() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
放回
sputbackc	将一个字符放回输入序列中 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
sungetc	将输入序列中的下一个指针向后移动一位 (std::basic_streambuf<CharT,Traits> 的公共成员函数)

受保护的成员函数

(构造函数)	构造一个 basic_streambuf 对象 (受保护的成员函数)
operator= (C++11)	替换一个 basic_streambuf 对象 (受保护的成员函数)
swap (C++11)	交换两个 basic_streambuf 对象 (受保护的成员函数)
区域设置
imbue [虚函数]	对关联区域设置的更改做出反应 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
定位
setbuf [虚函数]	如果允许，则用用户定义的数组替换缓冲区 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
seekoff [虚函数]	使用相对寻址重新定位输入序列、输出序列或两者的下一个指针 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
seekpos [虚函数]	使用绝对寻址重新定位输入序列、输出序列或两者的下一个指针 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
sync [虚函数]	将缓冲区与关联的字符序列同步 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
获取区域
showmanyc [虚函数]	如果已知，则获取关联输入序列中可用于输入的字符数 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
underflow [虚函数]	从关联的输入序列读取字符到获取区域 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
uflow [虚函数]	从关联的输入序列读取字符到获取区域并推进下一个指针 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
xsgetn [虚函数]	从输入序列读取多个字符 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
ebackgptregptr	返回指向获取区域的开头、当前字符和结尾的指针 (受保护的成员函数)
gbump	推进输入序列中的下一个指针 (受保护的成员函数)
setg	重新定位输入序列的开头、下一个和结尾指针 (受保护的成员函数)
放置区域
xsputn [虚函数]	将多个字符写入输出序列 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
overflow [虚函数]	将字符从放置区域写入到关联的输出序列 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
pbasepptrepptr	返回指向放置区域的开头、当前字符和结尾的指针 (受保护的成员函数)
pbump	推进输出序列的下一个指针 (受保护的成员函数)
setp	重新定位输出序列的开头、下一个和结尾指针 (受保护的成员函数)
放回
pbackfail [虚函数]	将字符放回输入序列中，可能会修改输入序列 (std::basic_streambuf<CharT,Traits> 的虚保护成员函数)

注解

特性测试 宏	值	Std	特性
__cpp_lib_fstream_native_handle	202306L	(C++26)	原生句柄支持

参见

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