std::basic_ifstream

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (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)

 

std::basic_ifstream

成員函式

basic_ifstream::basic_ifstream

basic_ifstream::operator= (C++11)

basic_ifstream::swap (C++11)

basic_ifstream::rdbuf

basic_ifstream::native_handle (C++26)

檔案操作

basic_ifstream::is_open

basic_ifstream::open

basic_ifstream::close

非成員函式

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

 

定義於標頭檔案 <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> 例項。

繼承圖

提供了用於常見字元型別的幾個 typedef

定義於標頭檔案 <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)	實現定義型別，它是可平凡複製且半正則的

成員函式

(建構函式)	構造檔案流 (public member function)
(解構函式) [virtual] (隱式宣告)	銷燬 basic_ifstream 和關聯的緩衝區，關閉檔案 (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_ifstream) (C++11)

特化 std::swap 演算法 (function template)

繼承自 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_ios

成員型別

成員型別	定義
char_type	CharT
traits_type	特性
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 每次寫入前定位到流末尾 二進位制 以二進位制模式開啟 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	指定事件型別 (列舉)
event_callback	回撥函式型別 (typedef)

註釋

特性測試宏	值	標準	特性
__cpp_lib_fstream_native_handle	202306L	(C++26)	原生控制代碼支援

示例

執行此程式碼

#include <fstream>
#include <iostream>
#include <string>
 
int main()
{
    std::string filename = "Test.b";
 
    // prepare a file to read
    double d = 3.14;
    std::ofstream(filename, std::ios::binary)
        .write(reinterpret_cast<char*>(&d), sizeof d) << 123 << "abc";
 
    // open file for reading
    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); // binary input
        int n;
        std::string s;
        if (istrm >> n >> s)                               // text input
            std::cout << "read back from file: " << d << ' ' << n << ' ' << s << '\n';
    }
}

輸出

read back from file: 3.14 123 abc