Namespaces
Variants

std:: basic_ifstream

From cppreference.net
< 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_filebuf )与高级接口( std::basic_istream )进行对接。

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

cpp/io/ios base cpp/io/basic ios cpp/io/basic istream std-basic ifstream-inheritance.svg

继承关系图

提供了多种常见字符类型的类型定义:

定义于头文件 <fstream>
类型 定义
std::ifstream std :: basic_ifstream < char >
std::wifstream std :: basic_ifstream < 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

成员函数

构造文件流
(公开成员函数)
(destructor)
[virtual] (implicitly declared)
析构 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

成员函数

状态函数
检查是否未发生错误(即 I/O 操作可用)
( 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 的公开成员函数)
内部可扩展数组
[static]
返回程序范围内唯一的整数,可安全用作 pword() iword() 的索引
( std::ios_base 的公开静态成员函数)
必要时调整私有存储大小并访问指定索引处的 long 元素
( std::ios_base 的公开成员函数)
必要时调整私有存储大小并访问指定索引处的 void * 元素
( std::ios_base 的公开成员函数)
杂项
注册事件回调函数
( std::ios_base 的公开成员函数)
设置 C++ 与 C I/O 库是否可互操作
( std::ios_base 的公开静态成员函数)
成员类
流异常
( std::ios_base 的公开成员类)
初始化标准流对象
( std::ios_base 的公开成员类)

成员类型与常量

类型 说明
流打开模式类型

同时定义以下常量:

常量 说明
app 每次写入前寻位到流结尾
binary 二进制模式 打开
in 为读打开
out 为写打开
trunc 打开时舍弃流的内容
ate 打开后立即寻位到流结尾

注释

功能测试 标准 功能
__cpp_lib_fstream_native_handle 202306L (C++26) 原生句柄支持

示例

#include <fstream>
#include <iostream>
#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 << "failed to open " << filename << '\n';
    else
    {
        double d;
        istrm.read(reinterpret_cast<char*>(&d), sizeof d); // 二进制输入
        int n;
        std::string s;
        if (istrm >> n >> s)                               // 文本输入
            std::cout << "read back from file: " << d << ' ' << n << ' ' << s << '\n';
    }
}

输出:

read back from file: 3.14 123 abc