| I/O manipulators | ||||
| Print functions(C++23) | ||||
| C-style I/O | ||||
| Buffers | ||||
(C++23) | ||||
(C++98/26*) | ||||
(C++20) | ||||
| Streams | ||||
| Abstractions | ||||
basic_istream | ||||
| File I/O | ||||
| 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) |
| Global objects | ||||
| Member functions | ||||
(C++11) | ||||
| Formatted input | ||||
| Unformatted input | ||||
| Positioning | ||||
| Miscellaneous | ||||
(C++11) | ||||
| Member classes | ||||
| Non-member functions | ||||
Defined in header <istream> | ||
template< class CharT, | ||
The class templatebasic_istream provides support for high level input operations on character streams. The supported operations include formatted input (e.g. integer values or whitespace-separated characters and characters strings) and unformatted input (e.g. raw characters and character arrays). This functionality is implemented in terms of the interface provided by the underlyingbasic_streambuf class, accessed through thebasic_ios base class. The only non-inherited data member ofbasic_istream, in most implementations, is the value returned bybasic_istream::gcount().
Inheritance diagram
Several typedefs for common character types are provided:
Defined in header <istream> | |
| Type | Definition |
std::istream | std::basic_istream<char> |
std::wistream | std::basic_istream<wchar_t> |
Contents |
Two global basic_istream objects are provided by the standard library.
Defined in header <iostream> | |
| reads from the standard C input streamstdin (global object)[edit] | |
| 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] |
| constructs the object (public member function)[edit] | |
[virtual] | destructs the object (virtual public member function)[edit] |
(C++11) | move-assigns from anotherbasic_istream(protected member function)[edit] |
Formatted input | |
| extracts formatted data (public member function)[edit] | |
Unformatted input | |
| extracts characters (public member function)[edit] | |
| reads the next character without extracting it (public member function)[edit] | |
| unextracts a character (public member function)[edit] | |
| puts a character into input stream (public member function)[edit] | |
| extracts characters until the given character is found (public member function)[edit] | |
| extracts and discards characters until the given character is found (public member function)[edit] | |
| extracts blocks of characters (public member function)[edit] | |
| extracts already available blocks of characters (public member function)[edit] | |
| returns number of characters extracted by last unformatted input operation (public member function)[edit] | |
Positioning | |
| returns the input position indicator (public member function)[edit] | |
| sets the input position indicator (public member function)[edit] | |
Miscellaneous | |
| synchronizes with the underlying storage device (public member function)[edit] | |
(C++11) | swaps stream objects, except for the associated buffer (protected member function)[edit] |
| implements basic logic for preparation of the stream for input operations (public member class)[edit] |
| extracts characters and character arrays (function template)[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] | |||||||||||||||||||||||||||||||||||||||