std::basic_fstream

ヘッダ `<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 の典型的な実装は、非派生データメンバを1つだけ保持します。それは、std::basic_filebuf<CharT, Traits> のインスタンスです。

継承図

一般的な文字型のためにいくつかの typedef が提供されています

ヘッダ `<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` である実装定義型[編集]

[編集] メンバ関数

(コンストラクタ)	ファイルストリームを構築する (public member function) [編集]
(デストラクタ) [仮想] (暗黙的に宣言される)	`basic_fstream` と関連バッファを破棄し、ファイルを閉じる (virtual public member function) [編集]
operator= (C++11)	ファイルストリームを移動する (public member function) [編集]
swap (C++11)	2つのファイルストリームをスワップする (public member function) [編集]
rdbuf	基となる生のファイルデバイスオブジェクトを返す (public member function) [編集]
native_handle (C++26)	基となる実装定義のハンドルを返す (public メンバ関数) [編集]
ファイル操作
is_open	ストリームに関連付けられたファイルがあるかチェックする (public member function) [編集]
open	ファイルを開き、ストリームに関連付ける (public member function) [編集]
close	関連付けられたファイルを閉じる (public member function) [編集]

[編集] 非メンバ関数

std::swap(std::basic_fstream)

(C++11)

std::swap アルゴリズムを特殊化する
(function template) [編集]

std::basic_istream から継承

メンバ関数

書式付き入力
operator>>	書式付きデータを抽出する (`std::basic_istream<CharT,Traits>`のpublicメンバ関数) [編集]
書式なし入力
get	文字を抽出する (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]
peek	次の文字を抽出せずに読み取る (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]
unget	文字を非抽出する (un-extract) (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]
putback	文字を入力ストリームに戻す (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]
getline	指定された文字が見つかるまで文字を抽出する (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]
ignore	指定された文字が見つかるまで文字を抽出して破棄する (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]
read	文字のブロックを抽出する (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]
readsome	すでに利用可能な文字のブロックを抽出する (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]
gcount	最後の書式なし入力操作によって抽出された文字数を返す (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]
位置付け
tellg	入力位置インジケータを返す (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]
seekg	入力位置インジケータを設定する (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]
その他
sync	基礎となるストレージデバイスと同期する (`std::basic_istream<CharT,Traits>` の public メンバ関数) [編集]

メンバクラス

sentry

入力操作のためのストリームの準備に関する基本的なロジックを実装する
(std::basic_istream<CharT,Traits> の public メンバクラス) [編集]

std::basic_ostream から継承

メンバ関数

書式付き出力
operator<<	書式付きデータを挿入する (`std::basic_ostream<CharT,Traits>`のpublicメンバ関数) [編集]
非書式付き出力
put	文字を挿入する (`std::basic_ostream<CharT,Traits>` の public メンバ関数) [編集]
write	文字ブロックを挿入する (`std::basic_ostream<CharT,Traits>` の public メンバ関数) [編集]
位置付け
tellp	出力位置インジケータを返す (`std::basic_ostream<CharT,Traits>` の public メンバ関数) [編集]
seekp	出力位置インジケータを設定する (`std::basic_ostream<CharT,Traits>` の public メンバ関数) [編集]
その他
flush	基礎となるストレージデバイスと同期する (`std::basic_ostream<CharT,Traits>` の public メンバ関数) [編集]

メンバクラス

sentry

出力操作のためにストリームを準備する基本的なロジックを実装する
(std::basic_ostream<CharT,Traits> の public メンバクラス) [編集]

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>` の public メンバ関数) [編集]
eof	ファイルの終端に達したかを確認する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
fail	エラーが発生したかを確認する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
bad	回復不能なエラーが発生したかを確認する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
operator!	エラーが発生したかを確認する (fail() のシノニム) (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
operator bool	エラーが発生していないかを確認する (`!`fail() のシノニム) (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
rdstate	状態フラグを返す (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
setstate	状態フラグを設定する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
clear	状態フラグを変更する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
書式化
copyfmt	書式化情報をコピーする (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
fill	フィル文字を管理する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
その他
exceptions	例外マスクを管理する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
imbue	ロケールを設定する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
rdbuf	関連付けられたストリームバッファを管理する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
tie	結びつけられたストリームを管理する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
narrow	文字をナロー化する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]
widen	文字をワイド化する (`std::basic_ios<CharT,Traits>` の public メンバ関数) [編集]

std::ios_base から継承

メンバ関数

書式化
flags	書式フラグを管理する (`std::ios_base` の public メンバ関数) [編集]
setf	特定の書式フラグを設定する (`std::ios_base` の public メンバ関数) [編集]
unsetf	特定の書式フラグをクリアする (`std::ios_base` の public メンバ関数) [編集]
precision	浮動小数点数操作の小数点以下の精度を管理する (`std::ios_base` の public メンバ関数) [編集]
width	フィールド幅を管理する (`std::ios_base` の public メンバ関数) [編集]
ロケール
imbue	ロケールを設定する (`std::ios_base` の public メンバ関数) [編集]
getloc	現在のロケールを返す (`std::ios_base` の public メンバ関数) [編集]
内部拡張可能配列
xalloc [static]	`pword()` と `iword()` のインデックスとして安全に使用できる、プログラム全体で一意な整数を返す (`std::ios_base` の public static メンバ関数) [編集]
iword	必要に応じてプライベートストレージのサイズを変更し、指定されたインデックスの long 要素にアクセスする (`std::ios_base` の public メンバ関数) [編集]
pword	必要に応じてプライベートストレージのサイズを変更し、指定されたインデックスの void* 要素にアクセスする (`std::ios_base` の public メンバ関数) [編集]
その他
register_callback	イベントコールバック関数を登録する (`std::ios_base` の public メンバ関数) [編集]
sync_with_stdio [static]	C++ と C の I/O ライブラリが相互運用可能かどうかを設定する (`std::ios_base` の public static メンバ関数) [編集]
メンバクラス
failure	ストリーム例外 (`std::ios_base` の public メンバクラス) [編集]
Init	標準ストリームオブジェクトを初期化する (`std::ios_base` の public メンバクラス) [編集]

メンバ型と定数

型説明

openmode

ストリームオープンモードの型

以下の定数も定義される

Constant	説明[編集]
`app`	各書き込みの前にストリームの末尾にシークする[編集]
`2進`	バイナリモードで開く[編集]
`in`	読み取り用に開く[編集]
`out`	書き込み用に開く[編集]
`trunc`	オープン時にストリームの内容を破棄する[編集]
`ate`	オープン直後にストリームの末尾にシークする[編集]
`noreplace` (C++23)	排他モードで開く[編集]

(typedef) [編集]

fmtflags

書式化フラグの型

以下の定数も定義される

Constant	説明[編集]
`10進`	整数I/Oに10進基数を使用する: std::dec を参照[編集]
`8進`	整数I/Oに8進基数を使用する: std::oct を参照[編集]
`16進`	整数I/Oに16進基数を使用する: std::hex を参照[編集]
`basefield`	dec \| oct \| hex。マスキング操作に便利[編集]
`left`	左寄せ（右側にフィル文字を追加）: std::left を参照[編集]
`right`	右寄せ（左側にフィル文字を追加）: std::right を参照[編集]
`internal`	内部寄せ（内部の指定された点にフィル文字を追加）: std::internal を参照[編集]
`adjustfield`	left \| right \| internal。マスキング操作に便利[編集]
`scientific`	浮動小数点数型を科学表記法、または fixed と組み合わせた場合は16進表記で生成する: std::scientific を参照[編集]
`fixed`	浮動小数点数型を固定小数点表記法、または scientific と組み合わせた場合は16進表記で生成する: 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

ストリームの状態の型

以下の定数も定義される

Constant	説明[編集]
`goodbit`	エラーなし[編集]
`badbit`	回復不能なストリームエラー[編集]
`failbit`	入出力操作が失敗した（書式化または抽出エラー）[編集]
`eofbit`	関連付けられた入力シーケンスがファイルの終端に達した[編集]

(typedef) [編集]

seekdir

シーク方向の型

以下の定数も定義される

Constant	説明[編集]
`beg`	ストリームの先頭[編集]
`end`	ストリームの末尾[編集]
`cur`	ストリーム位置インジケータの現在位置[編集]

(typedef) [編集]

event

イベントの種類を指定する
(enum) [編集]

event_callback

コールバック関数の型
(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 << "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ストリームから文字列にデータを読み込む
(function template) [編集]

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

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)

メンバ関数
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)

cppreference.com

名前空間

変種

表示

操作

std::basic_fstream

目次

[編集] メンバ型

[編集] メンバ関数

ファイル操作

[編集] 非メンバ関数

std::basic_istream から継承

メンバ関数

書式付き入力

書式なし入力

位置付け

その他

メンバクラス

std::basic_ostream から継承

メンバ関数

書式付き出力

非書式付き出力

位置付け

その他

メンバクラス

std::basic_ios から継承

メンバ型

メンバ関数

状態関数

書式化

その他

std::ios_base から継承

メンバ関数

書式化

ロケール

内部拡張可能配列

その他

メンバクラス

メンバ型と定数

[編集] 備考

[編集] 例

[編集] 関連項目

ナビゲーション

ツールボックス