Namespaces
Variants

std:: basic_filebuf

From cppreference.net
< cpp ‎ | io
定义于头文件 <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() 函数负责在文件与缓冲区获取区及放置区之间执行实际的I/O操作。当 CharT 不是 char 类型时,大多数实现会在文件中存储多字节字符,并使用 std::codecvt 语言环境 facet 来执行宽字符/多字节字符转换。

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

定义于头文件 <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) 实现定义类型 ,满足 TriviallyCopyable 且满足 semiregular

成员函数

公共成员函数

构造 basic_filebuf 对象
(公共成员函数)
(C++11)
赋值 basic_filebuf 对象
(公共成员函数)
(C++11)
交换两个 basic_filebuf 对象
(公共成员函数)
返回底层实现定义的句柄
(公共成员函数)
销毁 basic_filebuf 对象并在文件打开时关闭文件
(虚函数公共成员函数)
检查关联文件是否已打开
(公共成员函数)
打开文件并将其配置为关联的字符序列
(公共成员函数)
刷新输出区缓冲区并关闭关联文件
(公共成员函数)

受保护成员函数

[virtual]
可选提供可从文件输入的字符数量
(虚函数受保护成员函数)
[virtual]
从关联文件读取
(虚函数受保护成员函数)
[virtual]
从关联文件读取并推进获取区的下一个指针
(虚函数受保护成员函数)
[virtual]
回退输入序列以取消获取字符,不影响关联文件
(虚函数受保护成员函数)
[virtual]
从输出区向关联文件写入字符
(虚函数受保护成员函数)
[virtual]
提供用户提供的缓冲区或使此文件流无缓冲
(虚函数受保护成员函数)
[virtual]
使用相对寻址重新定位文件位置
(虚函数受保护成员函数)
[virtual]
使用绝对寻址重新定位文件位置
(虚函数受保护成员函数)
[virtual]
从输出区向关联文件写入字符
(虚函数受保护成员函数)
[virtual]
更改关联的区域设置
(虚函数受保护成员函数)

非成员函数

特化 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> 的虚公开成员函数)
本地化
更改关联的本地化设置并调用 imbue ( )
( std::basic_streambuf<CharT,Traits> 的公开成员函数)
获取关联本地化设置的副本
( 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> 的公开成员函数)
获取区域
获取获取区域中立即可用的字符数量
( std::basic_streambuf<CharT,Traits> 的公开成员函数)
推进输入序列后读取一个字符但不再次推进
( std::basic_streambuf<CharT,Traits> 的公开成员函数)
(C++17 中移除)
从输入序列读取一个字符并推进序列
( std::basic_streambuf<CharT,Traits> 的公开成员函数)
从输入序列读取一个字符但不推进序列
( std::basic_streambuf<CharT,Traits> 的公开成员函数)
调用 xsgetn ( )
( std::basic_streambuf<CharT,Traits> 的公开成员函数)
放置区域
向放置区域写入一个字符并推进下一个指针
( std::basic_streambuf<CharT,Traits> 的公开成员函数)
调用 xsputn ( )
( std::basic_streambuf<CharT,Traits> 的公开成员函数)
回退
将一个字符放回输入序列
( std::basic_streambuf<CharT,Traits> 的公开成员函数)
将输入序列中的下一个指针向后移动一位
( std::basic_streambuf<CharT,Traits> 的公开成员函数)

受保护成员函数

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

注释

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

另请参阅

对象类型,能够保存控制C输入输出流所需的所有信息
(类型定义)