std::basic_fstream

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名需求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (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_fstream

成员函数

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)

 

定义在头文件 <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> 实例。

继承关系图

为常见的字符类型提供了一些类型定义

定义在头文件 <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

成员函数

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

非成员函数

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

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

从 std::basic_istream 继承而来

成员函数

格式化输入
operator>>	提取格式化数据 (std::basic_istream<CharT,Traits> 的公有成员函数)
非格式化输入
get	提取字符 (std::basic_istream<CharT,Traits> 的公有成员函数)
peek	读取下一个字符而不提取它 (std::basic_istream<CharT,Traits> 的公有成员函数)
unget	取消提取一个字符 (std::basic_istream<CharT,Traits> 的公有成员函数)
putback	将一个字符放入输入流中 (std::basic_istream<CharT,Traits> 的公有成员函数)
getline	提取字符直到找到给定的字符 (std::basic_istream<CharT,Traits> 的公有成员函数)
ignore	提取并丢弃字符直到找到给定的字符 (std::basic_istream<CharT,Traits> 的公有成员函数)
read	提取字符块 (std::basic_istream<CharT,Traits> 的公有成员函数)
readsome	提取已可用的字符块 (std::basic_istream<CharT,Traits> 的公有成员函数)
gcount	返回最后一次无格式输入操作提取的字符数量 (std::basic_istream<CharT,Traits> 的公有成员函数)
定位
tellg	返回输入位置指示器 (std::basic_istream<CharT,Traits> 的公有成员函数)
seekg	设置输入位置指示器 (std::basic_istream<CharT,Traits> 的公有成员函数)
杂项
sync	与底层存储设备同步 (std::basic_istream<CharT,Traits> 的公有成员函数)

成员类

sentry

实现用于为输入操作准备流的基本逻辑 (std::basic_istream<CharT,Traits> 的公有成员类)

继承自 std::basic_ostream

成员函数

格式化输出
operator<<	插入格式化数据 (std::basic_ostream<CharT,Traits> 的公有成员函数)
无格式输出
put	插入一个字符 (std::basic_ostream<CharT,Traits> 的公有成员函数)
write	插入字符块 (std::basic_ostream<CharT,Traits> 的公有成员函数)
定位
tellp	返回输出位置指示器 (std::basic_ostream<CharT,Traits> 的公有成员函数)
seekp	设置输出位置指示器 (std::basic_ostream<CharT,Traits> 的公有成员函数)
杂项
flush	与底层存储设备同步 (std::basic_ostream<CharT,Traits> 的公有成员函数)

成员类

sentry

实现用于为输出操作准备流的基本逻辑 (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 操作可用 (std::basic_ios<CharT,Traits> 的公有成员函数)
eof	检查是否已到达文件末尾 (std::basic_ios<CharT,Traits> 的公有成员函数)
fail	检查是否发生了错误 (std::basic_ios<CharT,Traits> 的公有成员函数)
bad	检查是否发生了不可恢复的错误 (std::basic_ios<CharT,Traits> 的公有成员函数)
operator!	检查是否发生了错误（fail() 的同义词） (std::basic_ios<CharT,Traits> 的公有成员函数)
operator bool	检查是否没有发生错误（!fail() 的同义词） (std::basic_ios<CharT,Traits> 的公有成员函数)
rdstate	返回状态标志 (std::basic_ios<CharT,Traits> 的公有成员函数)
setstate	设置状态标志 (std::basic_ios<CharT,Traits> 的公有成员函数)
clear	修改状态标志 (std::basic_ios<CharT,Traits> 的公有成员函数)
格式化
copyfmt	复制格式信息 (std::basic_ios<CharT,Traits> 的公有成员函数)
fill	管理填充字符 (std::basic_ios<CharT,Traits> 的公有成员函数)
杂项
exceptions	管理异常掩码 (std::basic_ios<CharT,Traits> 的公有成员函数)
imbue	设置区域设置 (std::basic_ios<CharT,Traits> 的公有成员函数)
rdbuf	管理关联的流缓冲区 (std::basic_ios<CharT,Traits> 的公有成员函数)
tie	管理绑定的流 (std::basic_ios<CharT,Traits> 的公有成员函数)
narrow	缩窄字符 (std::basic_ios<CharT,Traits> 的公有成员函数)
widen	加宽字符 (std::basic_ios<CharT,Traits> 的公有成员函数)

继承自 std::ios_base

成员函数

格式化
flags	管理格式标志 (std::ios_base 的公共成员函数)
setf	设置特定的格式标志 (std::ios_base 的公共成员函数)
unsetf	清除特定的格式标志 (std::ios_base 的公共成员函数)
precision	管理浮点数运算的精度 (std::ios_base 的公共成员函数)
width	管理字段宽度 (std::ios_base 的公共成员函数)
语言环境
imbue	设置语言环境 (std::ios_base 的公共成员函数)
getloc	返回当前语言环境 (std::ios_base 的公共成员函数)
内部可扩展数组
xalloc [静态]	返回一个程序范围内的唯一整数，可安全地用作 pword() 和 iword() 的索引 (std::ios_base 的公共静态成员函数)
iword	根据需要调整私有存储的大小，并访问给定索引处的 long 元素 (std::ios_base 的公共成员函数)
pword	根据需要调整私有存储的大小，并访问给定索引处的 void* 元素 (std::ios_base 的公共成员函数)
杂项
register_callback	注册事件回调函数 (std::ios_base 的公共成员函数)
sync_with_stdio [静态]	设置 C++ 和 C I/O 库是否可互操作 (std::ios_base 的公共静态成员函数)
成员类
failure	流异常 (std::ios_base 的公共成员类)
Init	初始化标准流对象 (std::ios_base 的公共成员类)

成员类型和常量
类型	解释
openmode	流打开模式类型 还定义了以下常量 常量 解释 app 在每次写入之前，将文件指针定位到流的末尾 binary 以 二进制模式 打开 in 以读模式打开 out 以写模式打开 trunc 在打开时丢弃流的内容 ate 在打开后立即将文件指针定位到流的末尾 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 流中读取数据到字符串 (函数模板)