std::basic_filebuf

来自cppreference.com
< 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 。输入序列和输出序列都关联到同一文件,并为两种操作维护连接文件位置。

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

亦为常用字符类型定义二个特化:

定义于头文件 <streambuf>
 
类型 定义
filebuf basic_filebuf<char>
wfilebuf 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 对象
(公开成员函数)
(C++11)
赋值 basic_filebuf 对象
(公开成员函数)
(C++11)
交换二个 basic_filebuf 对象
(公开成员函数)
析构 basic_filebuf 对象并且若打开则关闭文件
(虚公开成员函数)
检查关联文件是否打开
(公开成员函数)
打开文件并配置它为关联字符序列
(公开成员函数)
冲入放置区缓冲区并关闭关联的文件
(公开成员函数)

受保护成员函数

可选地提供可用于从文件输入的字符数
(虚受保护成员函数)
从关联文件读取
(虚受保护成员函数)
[虚]
从关联文件读取,并令获取区的下一位置指针前进
(虚受保护成员函数)
回退输出序列以放回字符,不影响关联文件
(虚受保护成员函数)
从放置区写字符到关联的文件
(虚受保护成员函数)
[虚]
提供用户供应的缓冲区,或将此 filebuf 转变为无缓冲
(虚受保护成员函数)
用相对寻址重寻位文件位置
(虚受保护成员函数)
用绝对寻址重寻位文件位置
(虚受保护成员函数)
[虚]
从放置区写字符到关联文件
(虚受保护成员函数)
[虚]
更改关联的本地环境
(虚受保护成员函数)

非成员函数

特化 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> 的公开成员函数)
从输入序列读取一个字符并令序列前进
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
stossc
(C++98 中弃用)(C++17 中移除)
令输入序列前进,如同通过调用 sbumpc() 并舍弃结果
(公开成员函数)
从输入序列读取一个字符,而不令序列前进
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
调用 xsgetn()
(std::basic_streambuf<CharT,Traits> 的公开成员函数)
放置区
写一个字符到放置区域,并令 next 指针前进
(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 对象
(受保护成员函数)
本地环境
[虚]
更改关联的本地环境
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
寻位
[虚]
若容许则以用户定义数组替换缓冲区
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
用相对寻址重定位输入序列、输出序列或两者中的下一位置指针
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
用绝对寻址重定位输入序列、输出序列或两者中的下一位置指针
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
[虚]
将缓冲与关联的字符序列同步
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
获取区
若已知,则获得关联输入序列中可用于输入的字符数
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
从关联输入序列读取字符到获取区
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
[虚]
从输入序列读取字符到获取区,并令下一位置指针前进
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
[虚]
从输入序列读取多个字符
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
返回指向获取区起始、当前字符和末尾的指针
(受保护成员函数)
令输出序列中的下一位置指针前进
(受保护成员函数)
重定位输出序列的起始、下一位置和终止指针
(受保护成员函数)
放置区
[虚]
将多个字符写到输出序列
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
从放置区写入字符到关联的输出序列
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
返回指向放置区的起始、当前字符和末尾的指针
(受保护成员函数)
令输出序列中的下一位置指针前进
(受保护成员函数)
重定位输出序列的起始、下一位置和终止指针
(受保护成员函数)
回放
将字符放回输入序列,可能修改输入序列
(std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)