std::basic_fstream

定义于头文件 `<fstream>`
template< class CharT, class Traits = std::char_traits<CharT> > class basic_fstream : public std::basic_iostream<CharT, Traits>

类模板 basic_fstream 实现了基于文件的流的高级输入/输出操作。它将基于文件的流缓冲区 (std::basic_filebuf) 与 (std::basic_iostream) 的高级接口连接起来。

std::basic_fstream 的典型实现仅包含一个非派生数据成员：std::basic_filebuf<CharT, Traits> 的实例。

继承关系图

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

定义于头文件 `<fstream>`
类型	定义
`std::fstream`	std::basic_fstream<char>
`std::wfstream`	std::basic_fstream<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`[编辑]
`native_handle_type`(C++26)	实现定义类型，它是 TriviallyCopyable 且 `semiregular`[编辑]

[编辑] 成员函数

(构造函数)	构造文件流 (public member function) [编辑]
(析构函数) [virtual] (隐式声明)	析构 `basic_fstream` 和关联的缓冲区，关闭文件 (virtual public member function) [编辑]
operator= (C++11)	移动文件流 (public member function) [编辑]
swap (C++11)	交换两个文件流 (public member function) [编辑]
rdbuf	返回底层原始文件设备对象 (public member function) [编辑]
native_handle (C++26)	返回底层实现定义的句柄 (public member function) [编辑]
文件操作
is_open	检查流是否有关联的文件 (public member function) [编辑]
open	打开文件并将其与流关联 (public member function) [编辑]
close	关闭关联的文件 (public member function) [编辑]

[编辑] 非成员函数

std::swap(std::basic_fstream)

(C++11)

特化 std::swap 算法
(function template) [编辑]

继承自 std::basic_istream

成员函数

格式化输入
operator>>	提取格式化数据 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]
非格式化输入
get	提取字符 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]
peek	读取下一个字符但不提取它 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]
unget	取消提取一个字符 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]
putback	将字符放回输入流 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]
getline	提取字符直到找到给定字符 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]
ignore	提取并丢弃字符直到找到给定字符 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]
read	提取字符块 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]
readsome	提取已有的字符块 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]
gcount	返回上次非格式化输入操作提取的字符数 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]
定位
tellg	返回输入位置指示器 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]
seekg	设置输入位置指示器 (public member function of `std::basic_istream<CharT,Traits>`) [edit]
其他
sync	与底层存储设备同步 (public member function of `std::basic_istream<CharT,Traits>`) [编辑]

成员类

sentry

实现为输入操作准备流的基本逻辑
(public member class of std::basic_istream<CharT,Traits>) [编辑]

继承自 std::basic_ostream

成员函数

格式化输出
operator<<	插入格式化数据 (public member function of `std::basic_ostream<CharT,Traits>`) [编辑]
非格式化输出
put	插入一个字符 (public member function of `std::basic_ostream<CharT,Traits>`) [编辑]
write	插入字符块 (public member function of `std::basic_ostream<CharT,Traits>`) [编辑]
定位
tellp	返回输出位置指示器 (public member function of `std::basic_ostream<CharT,Traits>`) [编辑]
seekp	设置输出位置指示器 (public member function of `std::basic_ostream<CharT,Traits>`) [编辑]
其他
flush	与底层存储设备同步 (public member function of `std::basic_ostream<CharT,Traits>`) [edit]

成员类

sentry

实现为输出操作准备流的基本逻辑
(public member class of std::basic_ostream<CharT,Traits>) [编辑]

继承自 std::basic_ios

成员类型

成员类型	定义
`char_type`	`CharT`
`traits_type`	`Traits`
`int_type`	`Traits::int_type`
`pos_type`	`Traits::pos_type`
`off_type`	`Traits::off_type`

成员函数

状态函数
good	检查是否没有错误发生，即 I/O 操作可用 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
eof	检查是否已到达文件末尾 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
fail	检查是否发生错误 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
bad	检查是否发生了不可恢复的错误 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
operator!	检查是否发生错误（fail() 的同义词） (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
operator bool	检查是否没有错误发生（`!`fail() 的同义词） (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
rdstate	返回状态标志 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
setstate	设置状态标志 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
clear	修改状态标志 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
格式化
copyfmt	复制格式化信息 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
fill	管理填充字符 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
其他
exceptions	管理异常掩码 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
imbue	设置区域设置 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
rdbuf	管理关联的流缓冲区 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
tie	管理绑定的流 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
narrow	窄化字符 (public member function of `std::basic_ios<CharT,Traits>`) [编辑]
widen	宽化字符 (public member function of `std::basic_ios<CharT,Traits>`) [edit]

继承自 std::ios_base

成员函数

格式化
flags	管理格式标志 (public member function of `std::ios_base`) [编辑]
setf	设置特定格式标志 (public member function of `std::ios_base`) [编辑]
unsetf	清除特定格式标志 (public member function of `std::ios_base`) [编辑]
precision	管理浮点运算的十进制精度 (public member function of `std::ios_base`) [编辑]
width	管理字段宽度 (public member function of `std::ios_base`) [编辑]
区域设置
imbue	设置区域设置 (public member function of `std::ios_base`) [编辑]
getloc	返回当前区域设置 (public member function of `std::ios_base`) [编辑]
内部可扩展数组
xalloc [静态]	返回程序范围唯一的整数，可以安全地用作 `pword()` 和 `iword()` 的索引 (public static member function of `std::ios_base`) [编辑]
iword	必要时调整私有存储的大小，并访问给定索引处的 long 元素 (public member function of `std::ios_base`) [编辑]
pword	必要时调整私有存储的大小，并访问给定索引处的 void* 元素 (public member function of `std::ios_base`) [编辑]
其他
register_callback	注册事件回调函数 (public member function of `std::ios_base`) [编辑]
sync_with_stdio [静态]	设置 C++ 和 C I/O 库是否可互操作 (public static member function of `std::ios_base`) [编辑]
成员类
failure	流异常 (public member class of `std::ios_base`) [编辑]
Init	初始化标准流对象 (public member class of `std::ios_base`) [编辑]

成员类型和常量

类型解释

openmode

流打开模式类型

还定义了以下常量

常量	解释[编辑]
`app`	每次写入前定位到流的末尾[编辑]
`binary`	以二进制模式打开[编辑]
`in`	打开以进行读取[编辑]
`out`	打开以进行写入[编辑]
`截断`	打开时丢弃流的内容[编辑]
`定位到末尾`	打开后立即定位到流的末尾[编辑]
`noreplace` (C++23)	以独占模式打开[编辑]

(typedef) [编辑]

fmtflags

格式化标志类型

还定义了以下常量

常量	说明[编辑]
`dec`	对整数 I/O 使用十进制基数：参见 std::dec[编辑]
`oct`	对整数 I/O 使用八进制基数：参见 std::oct[编辑]
`hex`	对整数 I/O 使用十六进制基数：参见 std::hex[编辑]
`basefield`	dec \| oct \| hex. 用于掩码操作[编辑]
`left`	左对齐（向右添加填充字符）：参见 std::left[编辑]
`right`	右对齐（向左添加填充字符）：参见 std::right[编辑]
`internal`	内部对齐（向内部指定点添加填充字符）：参见 std::internal[编辑]
`adjustfield`	left \| right \| internal. 用于掩码操作[编辑]
`scientific`	使用科学计数法生成浮点类型，如果与 fixed 结合使用，则使用十六进制表示法：参见 std::scientific[编辑]
`fixed`	使用定点表示法生成浮点类型，如果与 scientific 结合使用，则使用十六进制表示法：参见 std::fixed[编辑]
`floatfield`	scientific \| fixed. 用于掩码操作[编辑]
`boolalpha`	以字母数字格式插入和提取 bool 类型：参见 std::boolalpha[编辑]
`showbase`	生成前缀以指示整数输出的数字基数，货币 I/O 中需要货币指示符：参见 std::showbase[编辑]
`showpoint`	无条件地为浮点数输出生成小数点字符：参见 std::showpoint[编辑]
`showpos`	为非负数输出生成 + 字符：参见 std::showpos[编辑]
`skipws`	跳过某些输入操作前的引导空白符：参见 std::skipws[编辑]
`unitbuf`	在每次输出操作后刷新输出：参见 std::unitbuf[编辑]
`uppercase`	在某些输出操作中，将某些小写字母替换为大写等效字母：参见 std::uppercase[编辑]

(typedef) [编辑]

iostate

流状态类型

还定义了以下常量

常量	说明[编辑]
`goodbit`	没有错误[编辑]
`badbit`	不可恢复的流错误[编辑]
`failbit`	输入/输出操作失败（格式化或提取错误）[编辑]
`eofbit`	关联的输入序列已到达文件结尾[编辑]

(typedef) [编辑]

seekdir

定位方向类型

还定义了以下常量

常量	说明[编辑]
`beg`	流的开始处[编辑]
`end`	流的结尾处[编辑]
`cur`	流位置指示器的当前位置[编辑]

(typedef) [编辑]

event

指定事件类型
(enum) [编辑]

event_callback

回调函数类型
(typedef) [编辑]

[编辑] 注释

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

[编辑] 示例

运行此代码

#include <fstream>
#include <iostream>
#include <string>
 
int main()
{
    std::string filename{"test.bin"};
    std::fstream s{filename, s.binary | s.trunc | s.in | s.out};
 
    if (!s.is_open())
        std::cout << "failed to open " << filename << '\n';
    else
    {
        // write
        double d{3.14};
        s.write(reinterpret_cast<char*>(&d), sizeof d); // binary output
        s << 123 << "abc";                              // text output
 
        // for fstream, this moves the file position pointer (both put and get)
        s.seekp(0);
 
        // read
        d = 2.71828;
        s.read(reinterpret_cast<char*>(&d), sizeof d); // binary input
        int n;
        std::string str;
        if (s >> n >> str)                             // text input
            std::cout << "read back from file: " << d << ' ' << n << ' ' << str << '\n';
    }
}

输出

read back from file: 3.14 123 abc

[编辑] 参见

getline

从 I/O 流中读取数据到字符串
(函数模板) [编辑]

编译器支持
独立和宿主
语言
标准库
标准库头文件
具名要求
特性测试宏 (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)

成员函数
basic_fstream::basic_fstream
basic_fstream::operator= (C++11)
basic_fstream::swap (C++11)
basic_fstream::rdbuf
basic_fstream::native_handle (C++26)
文件操作
basic_fstream::is_open
basic_fstream::open
basic_fstream::close
非成员函数
swap(std::basic_fstream) (C++11)

cppreference.cn

命名空间

变体

视图

操作

std::basic_fstream

内容

[编辑] 成员类型

[编辑] 成员函数

文件操作

[编辑] 非成员函数

继承自 std::basic_istream

成员函数

格式化输入

非格式化输入

定位

其他

成员类

继承自 std::basic_ostream

成员函数

格式化输出

非格式化输出

定位

其他

成员类

继承自 std::basic_ios

成员类型

成员函数

状态函数

格式化

其他

继承自 std::ios_base

成员函数

格式化

区域设置

内部可扩展数组

其他

成员类

成员类型和常量

[编辑] 注释

[编辑] 示例

[编辑] 参见

导航

工具箱