SysTutorials

Linux Manual Pages › Section 3

stdwiostream(3)

std::basic_iostream - std::basic_iostream

Synopsis

Defined in header <istream>
template<
class CharT,
class Traits = std::char_traits<CharT>
> class basic_iostream;

The class template basic_iostream provides support for high level input/output operations on streams. The supported operations include sequential reading or writing and formatting. This functionality is implemented over the interface provided by the basic_streambuf class. It is accessed through basic_ios class.  std-basic iostream-inheritance.svg Inheritance diagram Two specializations for common character types are defined: Defined in header <istream> Type Definition iostream basic_iostream<char> wiostream basic_iostream<wchar_t>

Member types

Member type Definition char_type CharT traits_type Traits; the program is ill-formed if Traits::char_type is not CharT. int_type Traits::int_type pos_type Traits::pos_type off_type Traits::off_type

Member functions

              constructs the object constructor (public member function)

destructor destructs the object               (virtual public member function) [virtual]

Protected member functions

operator= move-assigns another basic_iostream           (protected member function) (C++11)

swap exchanges the state with another basic_iostream           (public member function) (C++11)

Inherited from std::basic_istream

Member functions

Formatted input

           extracts formatted data operator>> (public member function of std::basic_istream<CharT,Traits>)

Unformatted input

           extracts characters get (public member function of std::basic_istream<CharT,Traits>)            reads the next character without extracting it peek (public member function of std::basic_istream<CharT,Traits>)            unextracts a character unget (public member function of std::basic_istream<CharT,Traits>)            puts character into input stream putback (public member function of std::basic_istream<CharT,Traits>)            extracts characters until the given character is found getline (public member function of std::basic_istream<CharT,Traits>)            extracts and discards characters until the given character is found ignore (public member function of std::basic_istream<CharT,Traits>)            extracts blocks of characters read (public member function of std::basic_istream<CharT,Traits>)            extracts already available blocks of characters readsome (public member function of std::basic_istream<CharT,Traits>)            returns number of characters extracted by last unformatted input operation gcount (public member function of std::basic_istream<CharT,Traits>)

Positioning

           returns the input position indicator tellg (public member function of std::basic_istream<CharT,Traits>)            sets the input position indicator seekg (public member function of std::basic_istream<CharT,Traits>)

Miscellaneous

           synchronizes with the underlying storage device sync (public member function of std::basic_istream<CharT,Traits>)

Member classes

       implements basic logic for preparation of the stream for input operations sentry (public member class of std::basic_istream<CharT,Traits>)

Inherited from std::basic_ostream

Member functions

Formatted output

           inserts formatted data operator<< (public member function of std::basic_ostream<CharT,Traits>)

Unformatted output

           inserts a character put (public member function of std::basic_ostream<CharT,Traits>)            inserts blocks of characters write (public member function of std::basic_ostream<CharT,Traits>)

Positioning

           returns the output position indicator tellp (public member function of std::basic_ostream<CharT,Traits>)            sets the output position indicator seekp (public member function of std::basic_ostream<CharT,Traits>)

Miscellaneous

           synchronizes with the underlying storage device flush (public member function of std::basic_ostream<CharT,Traits>)

Member classes

       implements basic logic for preparation of the stream for output operations sentry (public member class of std::basic_ostream<CharT,Traits>)

Inherited from std::basic_ios

Member types

Member type Definition char_type CharT traits_type Traits int_type Traits::int_type pos_type Traits::pos_type off_type Traits::off_type

Member functions

State functions

               checks if no error has occurred i.e. I/O operations are available good (public member function of std::basic_ios<CharT,Traits>)                checks if end-of-file has been reached eof (public member function of std::basic_ios<CharT,Traits>)                checks if an error has occurred fail (public member function of std::basic_ios<CharT,Traits>)                checks if a non-recoverable error has occurred bad (public member function of std::basic_ios<CharT,Traits>)                checks if an error has occurred (synonym of fail()) operator! (public member function of std::basic_ios<CharT,Traits>)

operator_void* operator_bool checks if no error has occurred (synonym of !fail())                (public member function of std::basic_ios<CharT,Traits>) (until C++11) (since C++11)                returns state flags rdstate (public member function of std::basic_ios<CharT,Traits>)                sets state flags setstate (public member function of std::basic_ios<CharT,Traits>)                modifies state flags clear (public member function of std::basic_ios<CharT,Traits>)

Formatting

               copies formatting information copyfmt (public member function of std::basic_ios<CharT,Traits>)                manages the fill character fill (public member function of std::basic_ios<CharT,Traits>)

Miscellaneous

               manages exception mask exceptions (public member function of std::basic_ios<CharT,Traits>)                sets the locale imbue (public member function of std::basic_ios<CharT,Traits>)                manages associated stream buffer rdbuf (public member function of std::basic_ios<CharT,Traits>)                manages tied stream tie (public member function of std::basic_ios<CharT,Traits>)                narrows characters narrow (public member function of std::basic_ios<CharT,Traits>)                widens characters widen (public member function of std::basic_ios<CharT,Traits>)

Inherited from std::ios_base

Member functions

Formatting

                  manages format flags flags (public member function of std::ios_base)                   sets specific format flag setf (public member function of std::ios_base)                   clears specific format flag unsetf (public member function of std::ios_base)                   manages decimal precision of floating point operations precision (public member function of std::ios_base)                   manages field width width (public member function of std::ios_base)

Locales

                  sets locale imbue (public member function of std::ios_base)                   returns current locale getloc (public member function of std::ios_base)

Internal extensible array

xalloc returns a program-wide unique integer that is safe to use as index to pword() and iword()                   (public static member function of std::ios_base) [static]                   resizes the private storage if necessary and access to the long element at the given index iword (public member function of std::ios_base)                   resizes the private storage if necessary and access to the void* element at the given index pword (public member function of std::ios_base)

Miscellaneous

                  registers event callback function register_callback (public member function of std::ios_base)

sync_with_stdio sets whether C++ and C IO libraries are interoperable                   (public static member function of std::ios_base) [static]

Member classes

                  stream exception failure (public member class of std::ios_base)                   initializes standard stream objects Init (public member class of std::ios_base)

Member types and constants

Type Explanation                stream open mode type                The following constants are also defined:

               Constant Explanation                app seek to the end of stream before each write                binary open in binary_mode openmode in open for reading                out open for writing                trunc discard the contents of the stream when opening                ate seek to the end of stream immediately after open

               (typedef)                formatting flags type                The following constants are also defined:

               Constant Explanation                dec use decimal base for integer I/O: see std::dec                oct use octal base for integer I/O: see std::oct                hex use hexadecimal base for integer I/O: see std::hex                basefield dec|oct|hex. Useful for masking operations                left left adjustment (adds fill characters to the right): see std::left                right right adjustment (adds fill characters to the left): see std::right                internal internal adjustment (adds fill characters to the internal designated point): see std::internal                adjustfield left|right|internal. Useful for masking operations                scientific generate floating point types using scientific notation, or hex notation if combined with fixed: see std::scientific fmtflags fixed generate floating point types using fixed notation, or hex notation if combined with scientific: see std::fixed                floatfield scientific|fixed. Useful for masking operations                boolalpha insert and extract bool type in alphanumeric format: see std::boolalpha                showbase generate a prefix indicating the numeric base for integer output, require the currency indicator in monetary I/O: see std::showbase                showpoint generate a decimal-point character unconditionally for floating-point number output: see std::showpoint                showpos generate a + character for non-negative numeric output: see std::showpos                skipws skip leading whitespace before certain input operations: see std::skipws                unitbuf flush the output after each output operation: see std::unitbuf                uppercase replace certain lowercase letters with their uppercase                            equivalents in certain output operations: see std::uppercase

               (typedef)                state of the stream type                The following constants are also defined:

               Constant Explanation                goodbit no error iostate badbit irrecoverable stream error                failbit input/output operation failed (formatting or extraction error)                eofbit associated input sequence has reached end-of-file

               (typedef)                seeking direction type                The following constants are also defined:

               Constant Explanation                beg the beginning of a stream seekdir end the ending of a stream                cur the current position of stream position indicator

               (typedef)                specifies event type event (enum)                callback function type event_callback (typedef)

See also

Input/output_manipulators