| I/O manipulators | ||||
| Print functions(C++23) | ||||
| C-style I/O | ||||
| Buffers | ||||
(C++23) | ||||
(C++98/26*) | ||||
(C++20) | ||||
| Streams | ||||
| Abstractions | ||||
| File I/O | ||||
basic_fstream | ||||
| String I/O | ||||
| Array I/O | ||||
(C++23) | ||||
(C++23) | ||||
(C++23) | ||||
(C++98/26*) | ||||
(C++98/26*) | ||||
(C++98/26*) | ||||
| Synchronized Output | ||||
(C++20) | ||||
| Types | ||||
| Error category interface | ||||
(C++11) | ||||
(C++11) |
| Member functions | ||||
(C++11) | ||||
(C++11) | ||||
(C++26) | ||||
| File operations | ||||
| Non-member functions | ||||
(C++11) |
Defined in header <fstream> | ||
template< class CharT, | ||
The class templatebasic_fstream implements high-level input/output operations on file based streams. It interfaces a file-based streambuffer (std::basic_filebuf) with the high-level interface of (std::basic_iostream).
A typical implementation ofstd::basic_fstream holds only one non-derived data member: an instance ofstd::basic_filebuf<CharT, Traits>.
Inheritance diagram
Several typedefs for common character types are provided:
Defined in header <fstream> | |
| Type | Definition |
std::fstream | std::basic_fstream<char> |
std::wfstream | std::basic_fstream<wchar_t> |
Contents |
| Member type | Definition |
char_type | CharT[edit] |
traits_type | Traits; the program is ill-formed ifTraits::char_type is notCharT.[edit] |
int_type | Traits::int_type[edit] |
pos_type | Traits::pos_type[edit] |
off_type | Traits::off_type[edit] |
native_handle_type(C++26) | implementation-defined type that isTriviallyCopyable andsemiregular[edit] |
| constructs the file stream (public member function)[edit] | |
(destructor) [virtual](implicitly declared) | destructs thebasic_fstream and the associated buffer, closes the file(virtual public member function)[edit] |
(C++11) | moves the file stream (public member function)[edit] |
(C++11) | swaps two file streams (public member function)[edit] |
| returns the underlying raw file device object (public member function)[edit] | |
(C++26) | returns the underlying implementation-defined handle (public member function)[edit] |
File operations | |
| checks if the stream has an associated file (public member function)[edit] | |
| opens a file and associates it with the stream (public member function)[edit] | |
| closes the associated file (public member function)[edit] | |
| specializes thestd::swap algorithm (function template)[edit] |
Formatted input | |
| extracts formatted data (public member function of std::basic_istream<CharT,Traits>)[edit] | |
Unformatted input | |
| extracts characters (public member function of std::basic_istream<CharT,Traits>)[edit] | |
| reads the next character without extracting it (public member function of std::basic_istream<CharT,Traits>)[edit] | |
| unextracts a character (public member function of std::basic_istream<CharT,Traits>)[edit] | |
| puts a character into input stream (public member function of std::basic_istream<CharT,Traits>)[edit] | |
| extracts characters until the given character is found (public member function of std::basic_istream<CharT,Traits>)[edit] | |
| extracts and discards characters until the given character is found (public member function of std::basic_istream<CharT,Traits>)[edit] | |
| extracts blocks of characters (public member function of std::basic_istream<CharT,Traits>)[edit] | |
| extracts already available blocks of characters (public member function of std::basic_istream<CharT,Traits>)[edit] | |
| returns number of characters extracted by last unformatted input operation (public member function of std::basic_istream<CharT,Traits>)[edit] | |
Positioning | |
| returns the input position indicator (public member function of std::basic_istream<CharT,Traits>)[edit] | |
| sets the input position indicator (public member function of std::basic_istream<CharT,Traits>)[edit] | |
Miscellaneous | |
| synchronizes with the underlying storage device (public member function of std::basic_istream<CharT,Traits>)[edit] | |
| implements basic logic for preparation of the stream for input operations (public member class of std::basic_istream<CharT,Traits>)[edit] |
Formatted output | |
| inserts formatted data (public member function of std::basic_ostream<CharT,Traits>)[edit] | |
Unformatted output | |
| inserts a character (public member function of std::basic_ostream<CharT,Traits>)[edit] | |
| inserts blocks of characters (public member function of std::basic_ostream<CharT,Traits>)[edit] | |
Positioning | |
| returns the output position indicator (public member function of std::basic_ostream<CharT,Traits>)[edit] | |
| sets the output position indicator (public member function of std::basic_ostream<CharT,Traits>)[edit] | |
Miscellaneous | |
| synchronizes with the underlying storage device (public member function of std::basic_ostream<CharT,Traits>)[edit] | |
| implements basic logic for preparation of the stream for output operations (public member class of std::basic_ostream<CharT,Traits>)[edit] |
| Member type | Definition |
char_type | CharT |
traits_type | Traits |
int_type | Traits::int_type |
pos_type | Traits::pos_type |
off_type | Traits::off_type |
State functions | |
| checks if no error has occurred i.e. I/O operations are available (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| checks if end-of-file has been reached (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| checks if an error has occurred (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| checks if a non-recoverable error has occurred (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| checks if an error has occurred (synonym offail()) (public member function of std::basic_ios<CharT,Traits>)[edit] | |
checks if no error has occurred (synonym of!fail())(public member function of std::basic_ios<CharT,Traits>)[edit] | |
| returns state flags (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| sets state flags (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| modifies state flags (public member function of std::basic_ios<CharT,Traits>)[edit] | |
Formatting | |
| copies formatting information (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| manages the fill character (public member function of std::basic_ios<CharT,Traits>)[edit] | |
Miscellaneous | |
| manages exception mask (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| sets the locale (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| manages associated stream buffer (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| manages tied stream (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| narrows characters (public member function of std::basic_ios<CharT,Traits>)[edit] | |
| widens characters (public member function of std::basic_ios<CharT,Traits>)[edit] | |
Formatting | |
| manages format flags (public member function of std::ios_base)[edit] | |
| sets specific format flag (public member function of std::ios_base)[edit] | |
| clears specific format flag (public member function of std::ios_base)[edit] | |
| manages decimal precision of floating point operations (public member function of std::ios_base)[edit] | |
| manages field width (public member function of std::ios_base)[edit] | |
Locales | |
| sets locale (public member function of std::ios_base)[edit] | |
| returns current locale (public member function of std::ios_base)[edit] | |
Internal extensible array | |
[static] | returns a program-wide unique integer that is safe to use as index topword() andiword() (public static member function of std::ios_base)[edit] |
| resizes the private storage if necessary and access to thelong element at the given index (public member function of std::ios_base)[edit] | |
| resizes the private storage if necessary and access to thevoid* element at the given index (public member function of std::ios_base)[edit] | |
Miscellaneous | |
| registers event callback function (public member function of std::ios_base)[edit] | |
[static] | sets whether C++ and C I/O libraries are interoperable (public static member function of std::ios_base)[edit] |
Member classes | |
| stream exception (public member class of std::ios_base)[edit] | |
| initializes standard stream objects (public member class of std::ios_base)[edit] | |
Member types and constants | |||||||||||||||||||||||||||||||||||||||
| Type | Explanation | ||||||||||||||||||||||||||||||||||||||
| stream open mode type The following constants are also defined:
(typedef)[edit] | |||||||||||||||||||||||||||||||||||||||
| formatting flags type The following constants are also defined:
(typedef)[edit] | |||||||||||||||||||||||||||||||||||||||
| state of the stream type The following constants are also defined:
(typedef)[edit] | |||||||||||||||||||||||||||||||||||||||
| seeking direction type The following constants are also defined:
(typedef)[edit] | |||||||||||||||||||||||||||||||||||||||
| specifies event type (enum)[edit] | |||||||||||||||||||||||||||||||||||||||
| callback function type (typedef)[edit] | |||||||||||||||||||||||||||||||||||||||
| Feature-test macro | Value | Std | Feature |
|---|---|---|---|
__cpp_lib_fstream_native_handle | 202306L | (C++26) | native handles support |
#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{// writedouble 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 inputint n;std::string str;if(s>> n>> str)// text inputstd::cout<<"read back from file: "<< d<<' '<< n<<' '<< str<<'\n';}}
Output:
read back from file: 3.14 123 abc
| read data from an I/O stream into a string (function template)[edit] |