std::basic_fstream

来自cppreference.com
< cpp‎ | io
在标头 <fstream> 定义
template<

    class CharT,
    class Traits = std::char_traits<CharT>

> class basic_fstream : public std::basic_iostream<CharT, Traits>

类模板 basic_fstream 实现基于文件的流上的高层输入/输出。它将 std::basic_iostream 的高层接口赋予基于文件的缓冲(std::basic_filebuf)。

std::basic_fstream 的典型实现只保有一个非派生数据成员:std::basic_filebuf<CharT, Traits> 的一个实例。

cpp/io/ios basecpp/io/basic ioscpp/io/basic istreamcpp/io/basic ostreamcpp/io/basic iostreamstd-basic fstream-inheritance.svg
关于这幅图像

继承图

提供了几个针对常用字符类型的 typedef:

在标头 <fstream> 定义
类型 定义
std::fstream std::basic_fstream<char>
std::wfstream std::basic_fstream<wchar_t>

目录

[编辑] 成员类型

成员类型 定义
char_type CharT[编辑]
traits_type TraitsTraits::char_type 不是 CharT 时程序非良构。[编辑]
int_type Traits::int_type[编辑]
pos_type Traits::pos_type[编辑]
off_type Traits::off_type[编辑]

[编辑] 成员函数

构造文件流
(公开成员函数) [编辑]
(析构函数)
[虚] (隐式声明)
析构 basic_fstream 和关联的缓冲区,并关闭文件
(虚公开成员函数) [编辑]
(C++11)
移动文件流
(公开成员函数) [编辑]
(C++11)
交换两个文件流
(公开成员函数) [编辑]
返回底层未处理的文件设备对象
(公开成员函数) [编辑]
返回底层的由实现定义的句柄
(公开成员函数) [编辑]
文件操作
检查流是否有关联文件
(公开成员函数) [编辑]
打开文件,并将它与流关联
(公开成员函数) [编辑]
关闭关联文件
(公开成员函数) [编辑]

[编辑] 非成员函数

特化 std::swap 算法
(函数模板) [编辑]

继承自 std::basic_istream

成员函数

有格式输入
提取带格式数据
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
无格式输入
提取字符
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
读取下一个字符,但不会提取它
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
撤销上一个字符的提取
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
往输入流中放置一个字符
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
持续提取字符,直到找到给定字符
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
持续提取并丢弃字符,直到找到给定字符
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
按区块提取字符
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
提取已经可用的字符区块
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
返回上次无格式输入操作提取的字符数量
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
寻位
返回输入位置指示器
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
设置输入位置指示器
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]
杂项
与底层存储设备同步
(std::basic_istream<CharT,Traits> 的公开成员函数) [编辑]

成员类

实现为输出操作准备流的基本逻辑
(std::basic_istream<CharT,Traits> 的公开成员类) [编辑]

继承自 std::basic_ostream

成员函数

有格式输出
插入带格式数据
(std::basic_ostream<CharT,Traits> 的公开成员函数) [编辑]
无格式输出
插入字符
(std::basic_ostream<CharT,Traits> 的公开成员函数) [编辑]
按区块插入字符
(std::basic_ostream<CharT,Traits> 的公开成员函数) [编辑]
寻位
返回输出位置指示器
(std::basic_ostream<CharT,Traits> 的公开成员函数) [编辑]
设置输出位置指示器
(std::basic_ostream<CharT,Traits> 的公开成员函数) [编辑]
杂项
与底层存储设备同步
(std::basic_ostream<CharT,Traits> 的公开成员函数) [编辑]

成员类

为输出操作实现流准备的基本逻辑
(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

成员函数

状态函数
检查是否没有发生错误,即是否可执行输入/输出操作
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
检查是否到达了文件末尾
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
检查是否发生了可恢复的错误
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
检查是否已发生不可恢复的错误
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
检查是否有错误发生(fail() 的同义词)
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
检查是否没有发生错误(!fail() 的同义词)
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
返回状态标志
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
设置状态标志
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
修改状态标志
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
格式化
复制格式化信息
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
管理填充字符
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
杂项
管理异常掩码
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
设置本地环境
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
管理相关的流缓冲区
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
管理绑定的流
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
窄化字符
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]
拓宽字符
(std::basic_ios<CharT,Traits> 的公开成员函数) [编辑]

继承自 std::ios_base

成员函数

格式化
管理格式标志
(std::ios_base 的公开成员函数) [编辑]
设置特定格式标志
(std::ios_base 的公开成员函数) [编辑]
清除特定格式的标志
(std::ios_base 的公开成员函数) [编辑]
管理浮点数操作的精度
(std::ios_base 的公开成员函数) [编辑]
管理字段宽度
(std::ios_base 的公开成员函数) [编辑]
本地环境
设置本地环境
(std::ios_base 的公开成员函数) [编辑]
返回当前本地环境
(std::ios_base 的公开成员函数) [编辑]
内部可扩展数组
[静态]
返回能安全用作 pword()iword() 的索引的程序范围内独有的整数
(std::ios_base 的公开静态成员函数) [编辑]
若必要则调整私有存储的大小,并访问位于给定索引的 long 元素
(std::ios_base 的公开成员函数) [编辑]
若需要则调整私有存储的大小,并访问位于给定索引的 void* 元素
(std::ios_base 的公开成员函数) [编辑]
杂项
注册事件回调函数
(std::ios_base 的公开成员函数) [编辑]
设置 C++ 和 C 的输入/输出库是否可以互操作
(std::ios_base 的公开静态成员函数) [编辑]
成员类
流异常
(std::ios_base 的公开成员类) [编辑]
初始化标准流对象
(std::ios_base 的公开成员类) [编辑]

成员类型和常量

类型 解释

流打开模式类型

同时定义下列常量:

常量 解释[编辑]
app 每次写入前寻位到流结尾[编辑]
binary 二进制模式打开[编辑]
in 为读打开[编辑]
out 为写打开[编辑]
trunc 在打开时舍弃流的内容[编辑]
ate 打开后立即寻位到流结尾[编辑]
noreplace (C++23) 以独占模式打开[编辑]

(typedef) [编辑]
格式化标志类型

亦定义下列常量:

常量 解释[编辑]
dec 为整数输入/输出使用十进制底:见 std::dec[编辑]
oct 为整数输入/输出使用八进制底:见 std::oct[编辑]
hex 为整数输入/输出使用十六进制底:见 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 生成为整数输出指示数字基底的前缀,货币输入/输出中要求现金指示符:见 std::showbase[编辑]
showpoint 无条件为浮点数输出生成小数点字符:见 std::showpoint[编辑]
showpos 为非负数值输出生成 + 字符:见 std::showpos[编辑]
skipws 在具体输入操作前跳过前导空白:见 std::skipws[编辑]
unitbuf 在每次输出操作后冲洗输出:见 std::unitbuf[编辑]
uppercase 在具体输出的输出操作中以大写等价替换小写字符:见 std::uppercase[编辑]

(typedef) [编辑]
流状态类型

亦定义下列常量:

常量 解释[编辑]
goodbit 无错误 [编辑]
badbit 不可恢复的流错误 [编辑]
failbit 输入/输出操作失败(格式化或提取错误) [编辑]
eofbit 关联的输出序列已抵达文件尾 [编辑]

(typedef) [编辑]
寻位方向类型

亦定义下列常量:

常量 解释[编辑]
beg 流的开始 [编辑]
end 流的结尾 [编辑]
cur 流位置指示器的当前位置 [编辑]

(typedef) [编辑]
指定事件类型
(枚举) [编辑]
回调函数类型
(typedef) [编辑]

[编辑] 注解

功能特性测试 标准 功能特性
__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 << "打开 " << filename << " 失败\n";
    else
    {
        // 写入
        double d = 3.14;
        s.write(reinterpret_cast<char*>(&d), sizeof d); // 二进制输出
        s << 123 << "abc";                              // 文本输出
 
        // 对于 fstream,这会移动文件位置指针(放置与获取)
        s.seekp(0);
 
        // 读取
        d = 2.71828;
        s.read(reinterpret_cast<char*>(&d), sizeof d); // 二进制输入
        int n;
        std::string str;
        if (s >> n >> str)                             // 文本输入
            std::cout << "从文件读回:" << d << ' ' << n << ' ' << str << '\n';
    }
}

输出:

从文件读回:3.14 123 abc

[编辑] 参阅

从输入/输出流读取数据到字符串
(函数模板) [编辑]