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 :publicstd::basic_streambuf<CharT, Traits>

std::basic_filebuf 是一种 std::basic_streambuf，其所关联的字符序列为文件。输入序列和输出序列都关联到同一文件，并为两种操作维护共同的文件位置。以 std::basic_filebuf 进行序列的读取和写入的制约与 std::FILE 的相同。

函数 underflow() 和 overflow() / sync() 进行文件和缓冲区的获取放置区之间的实际 输入/输出。CharT 不是 char 时，多数实现在文件存储多字节字符，并用 std::codecvt 平面进行宽/多字节字符转换。

提供了几个针对常用字符类型的 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	要求是 std::fpos<Traits::state_type> 的 Traits::pos_type
off_type	Traits::off_type

成员函数

公开成员函数
(构造函数)	构造 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> 的虚受保护成员函数)

注解

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

参阅

FILE	对象类型，足以保有控制 C 输入/输出流所需的全部信息 (typedef)