std::basic_ifstream

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

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

> class basic_ifstream : public std::basic_istream<CharT, Traits>

类模板 basic_ifstream 实现文件流上的高层输入操作。它将 std::basic_istream 的高层接口赋予基于文件的流缓冲(std::basic_filebuf)。

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

cpp/io/ios basecpp/io/basic ioscpp/io/basic istreamstd-basic ifstream-inheritance.svg

继承图

提供数个对于常用字符类型的 typedef:

在标头 <fstream> 定义
类型 定义
std::ifstream std::basic_ifstream<char>
std::wifstream std::basic_ifstream<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_ifstream 和关联的缓冲区,并关闭文件
(虚公开成员函数)
(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_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)

示例

#include <iostream>
#include <fstream>
#include <string>
 
int main()
{
    std::string filename = "Test.b";
 
    // 准备读取文件
    double d = 3.14;
    std::ofstream(filename, std::ios::binary)
        .write(reinterpret_cast<char*>(&d), sizeof d) << 123 << "abc";
 
    // 打开文件以读取
    std::ifstream istrm(filename, std::ios::binary);
    if (!istrm.is_open())
        std::cout << "打开 " << filename << " 失败\n";
    else
    {
        double d;
        istrm.read(reinterpret_cast<char*>(&d), sizeof d); // 二进制输入
        int n;
        std::string s;
        if (istrm >> n >> s)                               // 文本输入
            std::cout << "从文件读回:" << d << ' ' << n << ' ' << s << '\n';
    }
}

输出:

从文件读回:3.14 123 abc