logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

std::basic_ios< _CharT, _Traits > - Template class basic_ios, virtual base class for all stream classes.

Author

       Generated automatically by Doxygen for libstdc++ from the source code.

                                                    libstdc++            std::basic_ios<_CharT,_Traits>(3cxx)

Constructor & Destructor Documentation

template<typename_CharT,typename_Traits>std::basic_ios<_CharT,_Traits>::basic_ios(basic_streambuf<_CharT,_Traits>*__sb)[inline],[explicit]
       Constructor performs initialization. The parameter is passed by derived streams.

       References std::basic_ios<_CharT,_Traits>::init().

   template<typename_CharT,typename_Traits>virtualstd::basic_ios<_CharT,_Traits>::~basic_ios()[inline],[virtual]
       Empty. The destructor does nothing. More specifically, it does not destroy the streambuf held by rdbuf().

   template<typename_CharT,typename_Traits>std::basic_ios<_CharT,_Traits>::basic_ios()[inline],[protected]
       Empty. The default constructor does nothing and is not normally accessible to users.

Detailed Description

template<typename_CharT,typename_Traits>
       class std::basic_ios< _CharT, _Traits >"Template class basic_ios, virtual base class for all stream
       classes.

       TemplateParameters_CharT Type of character stream.
           _Traits Traits for character type, defaults to char_traits<_CharT>.

       Most of the member functions called dispatched on stream objects (e.g., std::cout.foo(bar);) are
       consolidated in this class.

Member Data Documentation

constfmtflagsstd::ios_base::adjustfield[static],[inherited]
       A mask of left|right|internal. Useful for the 2-arg form of setf.

       Referenced by std::num_put<_CharT,_OutIter>::do_put(), std::internal(), std::left(), and std::right().

   constopenmodestd::ios_base::app[static],[inherited]
       Seek to end before each write.

       Referenced by std::basic_filebuf<_CharT,_Traits>::overflow(), and std::basic_filebuf<_CharT,_Traits>::xsputn().

   constopenmodestd::ios_base::ate[static],[inherited]
       Open and seek to end immediately after opening.

       Referenced by std::basic_filebuf<_CharT,_Traits>::open().

   constiostatestd::ios_base::badbit[static],[inherited]
       Indicates  a loss of integrity in an input or output sequence (such as an irrecoverable read error from a
       file).

       Referenced by std::basic_istream<_CharT,_Traits>::sentry::sentry(),  std::basic_ios<_CharT,_Traits>::bad(),  std::basic_ios<_CharT,_Traits>::fail(),  std::basic_ostream<_CharT,_Traits>::flush(),
       std::basic_istream<_CharT,_Traits>::get(),  std::basic_istream<char>::get(),  std::basic_istream<_CharT,_Traits>::get(),  std::basic_ostream<_CharT,_Traits>::operator<<(),  std::operator>>(),
       std::basic_istream<_CharT,_Traits>::operator>>(),  std::basic_ostream<_CharT,_Traits>::put(),
       std::basic_istream<_CharT,_Traits>::putback(),  std::basic_istream<_CharT,_Traits>::read(),
       std::basic_istream<_CharT,_Traits>::readsome(),    std::basic_istream<char>::seekg(),
       std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_istream<_CharT,_Traits>::seekg(),
       std::basic_istream<_CharT,_Traits>::sync(),   std::basic_istream<_CharT,_Traits>::tellg(),
       std::basic_istream<char>::tellg(), and std::ws().

   constfmtflagsstd::ios_base::basefield[static],[inherited]
       A mask of dec|oct|hex. Useful for the 2-arg form of setf.

       Referenced  by  std::dec(),  std::num_get<_CharT,_InIter>::do_get(), std::num_put<_CharT,_OutIter>::do_put(), std::hex(), and std::oct().

   constseekdirstd::ios_base::beg[static],[inherited]
       Request a seek relative to the beginning of the stream.

       Referenced by std::basic_filebuf<_CharT,_Traits>::seekpos().

   constopenmodestd::ios_base::binary[static],[inherited]
       Perform input and output in binary mode (as opposed to text mode). This is probably not what you think it
       is; see https://gcc.gnu.org/onlinedocs/libstdc++/manual/fstreams.html#std.io.filestreams.binary.

       Referenced by std::basic_filebuf<_CharT,_Traits>::showmanyc().

   constfmtflagsstd::ios_base::boolalpha[static],[inherited]
       Insert/extract bool in alphabetic rather than numeric format.

       Referenced by std::boolalpha(), std::num_get<_CharT,_InIter>::do_get(), std::num_put<_CharT,_OutIter>::do_put(), and std::noboolalpha().

   constseekdirstd::ios_base::cur[static],[inherited]
       Request a seek relative to the current position within the sequence.

       Referenced  by  std::basic_filebuf<_CharT,_Traits>::imbue(),  std::basic_filebuf<_CharT,_Traits>::overflow(),  std::basic_filebuf<_CharT,_Traits>::pbackfail(), std::basic_filebuf<_CharT,_Traits>::seekoff(), std::basic_stringbuf<_CharT,_Traits,_Alloc>::seekoff(),  std::basic_istream<_CharT,_Traits>::tellg(), and std::basic_ostream<_CharT,_Traits>::tellp().

   constfmtflagsstd::ios_base::dec[static],[inherited]
       Converts integer input or generates integer output in decimal base.

       Referenced by std::dec().

   constseekdirstd::ios_base::end[static],[inherited]
       Request a seek relative to the current end of the sequence.

       Referenced  by  std::basic_filebuf<_CharT,_Traits>::open(), and std::basic_stringbuf<_CharT,_Traits,_Alloc>::seekoff().

   constiostatestd::ios_base::eofbit[static],[inherited]
       Indicates that an input operation reached the end of an input sequence.

       Referenced by std::basic_istream<_CharT,_Traits>::sentry::sentry(),  std::time_get<_CharT,_InIter>::do_get(),  std::num_get<_CharT,_InIter>::do_get(),  std::num_get<_CharT,_InIter>::do_get(),
       std::num_get<_CharT,_InIter>::do_get(),  std::num_get<_CharT,_InIter>::do_get(),  std::time_get<_CharT,_InIter>::do_get_date(),  std::time_get<_CharT,_InIter>::do_get_monthname(), std::time_get<_CharT,_InIter>::do_get_time(),  std::time_get<_CharT,_InIter>::do_get_weekday(),  std::time_get<_CharT,_InIter>::do_get_year(), std::basic_ios<_CharT,_Traits>::eof(), std::basic_istream<_CharT,_Traits>::get(),  std::basic_istream<_CharT,_Traits>::get(),  std::basic_istream<char>::get(),
       std::time_get<_CharT,_InIter>::get(),   std::basic_istream<_CharT,_Traits>::ignore(),
       std::basic_istream<_CharT,_Traits>::operator>>(),  std::operator>>(),  std::basic_istream<_CharT,_Traits>::putback(), std::basic_istream<_CharT,_Traits>::read(), std::basic_istream<_CharT,_Traits>::readsome(),  std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_istream<char>::sync(),  std::basic_istream<_CharT,_Traits>::unget(), and
       std::ws().

   constiostatestd::ios_base::failbit[static],[inherited]
       Indicates that an input operation failed to read the expected characters, or  that  an  output  operation
       failed to generate the desired characters.

       Referenced  by  std::basic_istream<_CharT,_Traits>::sentry::sentry(),  std::basic_ostream<_CharT,_Traits>::sentry::sentry(), std::num_get<_CharT,_InIter>::do_get(),  std::time_get<_CharT,_InIter>::do_get_monthname(), std::time_get<_CharT,_InIter>::do_get_weekday(), std::time_get<_CharT,_InIter>::do_get_year(),   std::basic_ios<_CharT,_Traits>::fail(),  std::basic_istream<_CharT,_Traits>::get(), std::basic_istream<_CharT,_Traits>::get(), std::basic_istream<char>::get(), std::time_get<_CharT,_InIter>::get(),  std::basic_istream<_CharT,_Traits>::operator>>(),   std::operator>>(),
       std::basic_istream<_CharT,_Traits>::operator>>(),  std::basic_istream<_CharT,_Traits>::read(),
       std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_istream<_CharT,_Traits>::seekg(),
       std::basic_ostream<_CharT,_Traits>::seekp(), and std::basic_ostream<_CharT,_Traits>::seekp().

   constfmtflagsstd::ios_base::fixed[static],[inherited]
       Generate floating-point output in fixed-point notation.

       Referenced by std::fixed(), and std::hexfloat().

   constfmtflagsstd::ios_base::floatfield[static],[inherited]
       A mask of scientific|fixed. Useful for the 2-arg form of setf.

       Referenced by std::defaultfloat(), std::fixed(), std::hexfloat(), and std::scientific().

   constiostatestd::ios_base::goodbit[static],[inherited]
       Indicates all is well.

       Referenced  by  std::basic_istream<_CharT,_Traits>::sentry::sentry(), std::time_get<_CharT,_InIter>::do_get(),   std::num_get<_CharT,_InIter>::do_get(),    std::time_get<_CharT,_InIter>::do_get_monthname(), std::time_get<_CharT,_InIter>::do_get_weekday(), std::time_get<_CharT,_InIter>::do_get_year(),  std::basic_ostream<_CharT,_Traits>::flush(), std::basic_istream<_CharT,_Traits>::get(), std::basic_istream<_CharT,_Traits>::get(),  std::basic_istream<_CharT,_Traits>::get(),
       std::basic_istream<char>::get(), std::basic_istream<_CharT,_Traits>::get(), std::time_get<_CharT,_InIter>::get(), std::basic_istream<_CharT,_Traits>::ignore(),  std::basic_istream<_CharT,_Traits>::ignore(),  std::basic_ostream<_CharT,_Traits>::operator<<(), std::basic_istream<_CharT,_Traits>::operator>>(),    std::operator>>(),    std::basic_istream<_CharT,_Traits>::operator>>(),
       std::basic_ostream<_CharT,_Traits>::put(),  std::basic_istream<_CharT,_Traits>::putback(),
       std::basic_istream<_CharT,_Traits>::read(),  std::basic_istream<_CharT,_Traits>::readsome(),
       std::basic_istream<char>::readsome(),    std::basic_istream<_CharT,_Traits>::seekg(),
       std::basic_istream<_CharT,_Traits>::seekg(),   std::basic_istream<_CharT,_Traits>::sync(),
       std::basic_istream<_CharT,_Traits>::unget(), and std::ws().

   constfmtflagsstd::ios_base::hex[static],[inherited]
       Converts integer input or generates integer output in hexadecimal base.

       Referenced  by std::num_get<_CharT,_InIter>::do_get(), std::num_put<_CharT,_OutIter>::do_put(), and
       std::hex().

   constopenmodestd::ios_base::in[static],[inherited]
       Open for input. Default for ifstream and fstream.

       Referenced by std::basic_stringbuf<_CharT,_Traits,_Alloc>::overflow(),  std::basic_filebuf<_CharT,_Traits>::pbackfail(),  std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_istream<_CharT,_Traits>::seekg(), std::basic_stringbuf<_CharT,_Traits,_Alloc>::seekoff(),  std::basic_stringbuf<_CharT,_Traits,_Alloc>::seekpos(),   std::basic_filebuf<_CharT,_Traits>::showmanyc(),
       std::basic_istream<_CharT,_Traits>::tellg(),  std::basic_filebuf<_CharT,_Traits>::underflow(),
       std::basic_stringbuf<_CharT,_Traits,_Alloc>::underflow(), and std::basic_filebuf<_CharT,_Traits>::xsgetn().

   constfmtflagsstd::ios_base::internal[static],[inherited]
       Adds fill characters at a designated internal point in certain generated output, or identical to right if
       no such point is designated.

       Referenced by std::internal().

   constfmtflagsstd::ios_base::left[static],[inherited]
       Adds fill characters on the right (final positions) of certain generated output.  (I.e.,  the  thing  you
       print is flush left.)

       Referenced by std::num_put<_CharT,_OutIter>::do_put(), and std::left().

   constfmtflagsstd::ios_base::oct[static],[inherited]
       Converts integer input or generates integer output in octal base.

       Referenced by std::oct().

   constopenmodestd::ios_base::out[static],[inherited]
       Open for output. Default for ofstream and fstream.

       Referenced  by  std::basic_filebuf<_CharT,_Traits>::overflow(), std::basic_stringbuf<_CharT,_Traits,_Alloc>::overflow(), std::basic_stringbuf<_CharT,_Traits,_Alloc>::pbackfail(), std::basic_stringbuf<_CharT,_Traits,_Alloc>::seekoff(), std::basic_ostream<_CharT,_Traits>::seekp(), std::basic_ostream<_CharT,_Traits>::seekp(),   std::basic_stringbuf<_CharT,_Traits,_Alloc>::seekpos(),
       std::basic_ostream<_CharT,_Traits>::tellp(), and std::basic_filebuf<_CharT,_Traits>::xsputn().

   constfmtflagsstd::ios_base::right[static],[inherited]
       Adds  fill  characters  on the left (initial positions) of certain generated output. (I.e., the thing you
       print is flush right.)

       Referenced by std::right().

   constfmtflagsstd::ios_base::scientific[static],[inherited]
       Generates floating-point output in scientific notation.

       Referenced by std::hexfloat(), and std::scientific().

   constfmtflagsstd::ios_base::showbase[static],[inherited]
       Generates a prefix indicating the numeric base of generated integer output.

       Referenced by std::num_put<_CharT,_OutIter>::do_put(), std::noshowbase(), and std::showbase().

   constfmtflagsstd::ios_base::showpoint[static],[inherited]
       Generates a decimal-point character unconditionally in generated floating-point output.

       Referenced by std::noshowpoint(), and std::showpoint().

   constfmtflagsstd::ios_base::showpos[static],[inherited]
       Generates a + sign in non-negative generated numeric output.

       Referenced by std::noshowpos(), and std::showpos().

   constfmtflagsstd::ios_base::skipws[static],[inherited]
       Skips leading white space before certain input operations.

       Referenced    by    std::basic_istream<_CharT,_Traits>::sentry::sentry(),    std::noskipws(),
       std::__detail::operator>>(), and std::skipws().

   constopenmodestd::ios_base::trunc[static],[inherited]
       Truncate an existing stream when opening. Default for ofstream.

   constfmtflagsstd::ios_base::unitbuf[static],[inherited]
       Flushes output after each output operation.

       Referenced by std::nounitbuf(), and std::unitbuf().

   constfmtflagsstd::ios_base::uppercase[static],[inherited]
       Replaces certain lowercase letters with their uppercase equivalents in generated output.

       Referenced by std::num_put<_CharT,_OutIter>::do_put(), std::nouppercase(), and std::uppercase().

Member Enumeration Documentation

enumstd::ios_base::event[inherited]
       The set of events that may be passed to  an  event  callback.  erase_event  is  used  during  ~ios()  and
       copyfmt(). imbue_event is used during imbue(). copyfmt_event is used during copyfmt().

Member Function Documentation

constlocale&std::ios_base::_M_getloc()const[inline],[inherited]
       Locale access.

       Returns
           A reference to the current locale.

       Like getloc above, but returns a reference instead of generating a copy.

   template<typename_CharT,typename_Traits>boolstd::basic_ios<_CharT,_Traits>::bad()const[inline]
       Fast error checking.

       Returns
           True if the badbit is set.

       Note that other iostate flags may also be set.

       References std::ios_base::badbit, and std::basic_ios<_CharT,_Traits>::rdstate().

   template<typename_CharT,typename_Traits>voidstd::basic_ios<_CharT,_Traits>::clear(iostate__state=goodbit)
       [Re]sets the error state.

       Parameters__state The new state flag(s) to set.

       See std::ios_base::iostate for the possible bit values. Most users will not need to pass an argument.

       Referenced  by  std::basic_ios<_CharT,_Traits>::exceptions(),  std::basic_istream<_CharT,_Traits>::putback(),  std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_ios<_CharT,_Traits>::setstate(),  and  std::basic_istream<_CharT,_Traits>::unget().

   template<typename_CharT,typename_Traits>basic_ios<_CharT,_Traits>&std::basic_ios<_CharT,_Traits>::copyfmt(constbasic_ios<_CharT,_Traits>&__rhs)
       Copies fields of __rhs into this.

       Parameters__rhs The source values for the copies.

       Returns
           Reference to this object.

       All  fields  of __rhs are copied into this object except that rdbuf() and rdstate() remain unchanged. All
       values in the pword and  iword  arrays  are  copied.  Before  copying,  each  callback  is  invoked  with
       erase_event.  After copying, each (new) callback is invoked with copyfmt_event. The final step is to copy
       exceptions().

       References std::__addressof(), std::basic_ios<_CharT,_Traits>::tie(), and std::tie().

   template<typename_CharT,typename_Traits>boolstd::basic_ios<_CharT,_Traits>::eof()const[inline]
       Fast error checking.

       Returns
           True if the eofbit is set.

       Note that other iostate flags may also be set.

       References std::ios_base::eofbit, and std::basic_ios<_CharT,_Traits>::rdstate().

   template<typename_CharT,typename_Traits>iostatestd::basic_ios<_CharT,_Traits>::exceptions()const[inline]
       Throwing exceptions on errors.

       Returns
           The current exceptions mask.

       This  changes  nothing in the stream. See the one-argument version of exceptions(iostate) for the meaning
       of the return value.

   template<typename_CharT,typename_Traits>voidstd::basic_ios<_CharT,_Traits>::exceptions(iostate__except)[inline]
       Throwing exceptions on errors.

       Parameters__except The new exceptions mask.

       By default, error flags are set silently. You can set an exceptions mask for each stream; if a bit in the
       mask becomes set in the error flags, then an exception of type std::ios_base::failure is thrown.

       If  the error flag is already set when the exceptions mask is added, the exception is immediately thrown.
       Try running the following under GCC 3.1 or later:

       #include <iostream>
       #include <fstream>
       #include <exception>

       int main()
       {
           std::set_terminate (__gnu_cxx::__verbose_terminate_handler);

           std::ifstream f ("/etc/motd");

           std::cerr << "Setting badbit\n";
           f.setstate (std::ios_base::badbit);

           std::cerr << "Setting exception mask\n";
           f.exceptions (std::ios_base::badbit);
       }

       References std::basic_ios<_CharT,_Traits>::clear().

   template<typename_CharT,typename_Traits>boolstd::basic_ios<_CharT,_Traits>::fail()const[inline]
       Fast error checking.

       Returns
           True if either the badbit or the failbit is set.

       Checking the badbit in fail() is historical practice. Note that other iostate flags may also be set.

       References   std::ios_base::badbit,   std::ios_base::failbit,   and   std::basic_ios<_CharT,_Traits>::rdstate().

       Referenced  by  std::basic_ios<_CharT,_Traits>::operatorbool(),  std::basic_ios<_CharT,_Traits>::operator!(), std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_istream<_CharT,_Traits>::seekg(),   std::basic_ostream<_CharT,_Traits>::seekp(),  std::basic_ostream<_CharT,_Traits>::seekp(), std::basic_istream<_CharT,_Traits>::tellg(),  and  std::basic_ostream<_CharT,_Traits>::tellp().

   template<typename_CharT,typename_Traits>char_typestd::basic_ios<_CharT,_Traits>::fill()const[inline]
       Retrieves the empty character.

       Returns
           The current fill character.

       It defaults to a space (' ') in the current locale.

       References std::basic_ios<_CharT,_Traits>::widen().

       Referenced by std::basic_ios<_CharT,_Traits>::fill().

   template<typename_CharT,typename_Traits>char_typestd::basic_ios<_CharT,_Traits>::fill(char_type__ch)[inline]
       Sets a new empty character.

       Parameters__ch The new character.

       Returns
           The previous fill character.

       The  fill  character is used to fill out space when P+ characters have been requested (e.g., via setw), Q
       characters are actually used, and Q<P. It defaults to a space (' ') in the current locale.

       References std::basic_ios<_CharT,_Traits>::fill().

   fmtflagsstd::ios_base::flags()const[inline],[inherited]
       Access to format flags.

       Returns
           The format control flags for both input and output.

   fmtflagsstd::ios_base::flags(fmtflags__fmtfl)[inline],[inherited]
       Setting new format flags all at once.

       Parameters__fmtfl The new flags to set.

       Returns
           The previous format control flags.

       This function overwrites all the format flags with __fmtfl.

   localestd::ios_base::getloc()const[inline],[inherited]
       Locale access.

       Returns
           A copy of the current locale.

       If imbue(loc) has previously been called, then this function returns loc. Otherwise, it returns a copy of
       std::locale(), the global C++ locale.

   template<typename_CharT,typename_Traits>boolstd::basic_ios<_CharT,_Traits>::good()const[inline]
       Fast error checking.

       Returns
           True if no error flags are set.

       A wrapper around rdstate.

       References std::basic_ios<_CharT,_Traits>::rdstate().

   template<typename_CharT,typename_Traits>localestd::basic_ios<_CharT,_Traits>::imbue(constlocale&__loc)
       Moves to a new locale.

       Parameters__loc The new locale.

       Returns
           The previous locale.

       Calls ios_base::imbue(loc), and if a stream buffer is associated with this stream,  calls  that  buffer's
       pubimbue(loc).

       Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html

       References std::ios_base::imbue().

   template<typename_CharT,typename_Traits>voidstd::basic_ios<_CharT,_Traits>::init(basic_streambuf<_CharT,_Traits>*__sb)[protected]
       All setup is performed here. This is called from the public constructor. It is not virtual and cannot  be
       redefined.

       Referenced by std::basic_ios<_CharT,_Traits>::basic_ios().

   long&std::ios_base::iword(int__ix)[inline],[inherited]
       Access to integer array.

       Parameters__ix Index into the array.

       Returns
           A reference to an integer associated with the index.

       The  iword  function  provides access to an array of integers that can be used for any purpose. The array
       grows as required to hold the supplied index. All integers in the array are initialized to 0.

       The implementation reserves several indices. You should use xalloc to obtain an index  that  is  safe  to
       use. Also note that since the array can grow dynamically, it is not safe to hold onto the reference.

   template<typename_CharT,typename_Traits>charstd::basic_ios<_CharT,_Traits>::narrow(char_type__c,char__dfault)const[inline]
       Squeezes characters.

       Parameters__c The character to narrow.
           __dfault The character to narrow.

       Returns
           The narrowed character.

       Maps a character of char_type to a character of char, if possible.

       Returns the result of

       std::use_facet<ctype<char_type> >(getloc()).narrow(c,dfault)

       Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html

   template<typename_CharT,typename_Traits>std::basic_ios<_CharT,_Traits>::operatorbool()const[inline],[explicit]
       The quick-and-easy status check. This allows you to write constructs such as if (!a_stream) ... and while
       (a_stream) ...

       References std::basic_ios<_CharT,_Traits>::fail().

   template<typename_CharT,typename_Traits>boolstd::basic_ios<_CharT,_Traits>::operator!()const[inline]
       The quick-and-easy status check. This allows you to write constructs such as if (!a_stream) ... and while
       (a_stream) ...

       References std::basic_ios<_CharT,_Traits>::fail().

   streamsizestd::ios_base::precision()const[inline],[inherited]
       Flags access.

       Returns
           The precision to generate on certain output operations.

       Be careful if you try to give a definition of precision here; see DR 189.

   streamsizestd::ios_base::precision(streamsize__prec)[inline],[inherited]
       Changing flags.

       Parameters__prec The new precision value.

       Returns
           The previous value of precision().

   void*&std::ios_base::pword(int__ix)[inline],[inherited]
       Access to void pointer array.

       Parameters__ix Index into the array.

       Returns
           A reference to a void* associated with the index.

       The pword function provides access to an array of pointers that can be used for any  purpose.  The  array
       grows as required to hold the supplied index. All pointers in the array are initialized to 0.

       The  implementation  reserves  several  indices. You should use xalloc to obtain an index that is safe to
       use. Also note that since the array can grow dynamically, it is not safe to hold onto the reference.

   template<typename_CharT,typename_Traits>basic_streambuf<_CharT,_Traits>*std::basic_ios<_CharT,_Traits>::rdbuf()const[inline]
       Accessing the underlying buffer.

       Returns
           The current stream buffer.

       This does not change the state of the stream.

       Referenced  by  std::basic_ostream<_CharT,_Traits>::flush(),  std::basic_istream<_CharT,_Traits>::get(), std::basic_istream<_CharT,_Traits>::get(),  std::basic_istream<_CharT,_Traits>::get(),
       std::basic_istream<char>::get(), std::basic_istream<_CharT,_Traits>::ignore(), std::basic_istream<_CharT,_Traits>::ignore(), std::basic_istream<_CharT,_Traits>::operator>>(),  std::basic_ostream<_CharT,_Traits>::put(), std::basic_istream<_CharT,_Traits>::putback(), std::basic_istream<_CharT,_Traits>::read(),  std::basic_istream<char>::readsome(),   std::basic_istream<_CharT,_Traits>::readsome(),  std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_ostream<_CharT,_Traits>::seekp(),   std::basic_ostream<_CharT,_Traits>::seekp(),   std::basic_istream<_CharT,_Traits>::sync(),  std::basic_istream<_CharT,_Traits>::tellg(), and std::basic_ostream<_CharT,_Traits>::tellp().

   template<typename_CharT,typename_Traits>basic_streambuf<_CharT,_Traits>*std::basic_ios<_CharT,_Traits>::rdbuf(basic_streambuf<_CharT,_Traits>*__sb)
       Changing the underlying buffer.

       Parameters__sb The new stream buffer.

       Returns
           The previous stream buffer.

       Associates a new buffer with the current stream, and clears the error state.

       Due  to  historical  accidents  which  the  LWG refuses to correct, the I/O library suffers from a design
       error: this function is hidden in derived classes by overrides of the  zero-argument  rdbuf(),  which  is
       non-virtual  for  hysterical  raisins.  As  a result, you must use explicit qualifications to access this
       function via any derived class. For example:

       std::fstream     foo;         // or some other derived type
       std::streambuf*  p = .....;

       foo.ios::rdbuf(p);            // ios == basic_ios<char>

   template<typename_CharT,typename_Traits>iostatestd::basic_ios<_CharT,_Traits>::rdstate()const[inline]
       Returns the error state of the stream buffer.

       Returns
           A bit pattern (well, isn't everything?)

       See  std::ios_base::iostate  for  the  possible  bit values. Most users will call one of the interpreting
       wrappers, e.g., good().

       Referenced by  std::basic_ios<_CharT,_Traits>::bad(),  std::basic_ios<_CharT,_Traits>::eof(),
       std::basic_ios<_CharT,_Traits>::fail(), std::basic_ios<_CharT,_Traits>::good(), std::basic_istream<_CharT,_Traits>::putback(), std::basic_istream<_CharT,_Traits>::seekg(), std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_ios<_CharT,_Traits>::setstate(),  and  std::basic_istream<_CharT,_Traits>::unget().

   voidstd::ios_base::register_callback(event_callback__fn,int__index)[inherited]
       Add the callback __fn with parameter __index.

       Parameters__fn The function to add.
           __index The integer to pass to the function when invoked.

       Registers a function as an event callback with an integer parameter to be passed  to  the  function  when
       invoked.  Multiple  copies of the function are allowed. If there are multiple callbacks, they are invoked
       in the order they were registered.

   fmtflagsstd::ios_base::setf(fmtflags__fmtfl)[inline],[inherited]
       Setting new format flags.

       Parameters__fmtfl Additional flags to set.

       Returns
           The previous format control flags.

       This function sets additional flags in format control. Flags that were previously set remain set.

   fmtflagsstd::ios_base::setf(fmtflags__fmtfl,fmtflags__mask)[inline],[inherited]
       Setting new format flags.

       Parameters__fmtfl Additional flags to set.
           __mask The flags mask for fmtfl.

       Returns
           The previous format control flags.

       This  function  clears  mask  in  the  format  flags,  then  sets  fmtfl  &  mask.  An  example  mask  is
       ios_base::adjustfield.

   template<typename_CharT,typename_Traits>voidstd::basic_ios<_CharT,_Traits>::setstate(iostate__state)[inline]
       Sets additional flags in the error state.

       Parameters__state The additional state flag(s) to set.

       See std::ios_base::iostate for the possible bit values.

       References std::basic_ios<_CharT,_Traits>::clear(), and std::basic_ios<_CharT,_Traits>::rdstate().

       Referenced  by  std::basic_ostream<_CharT,_Traits>::flush(),  std::basic_istream<_CharT,_Traits>::get(),   std::basic_istream<_CharT,_Traits>::get(),   std::basic_ostream<_CharT,_Traits>::operator<<(), std::basic_istream<_CharT,_Traits>::operator>>(), std::basic_istream<_CharT,_Traits>::operator>>(), std::basic_istream<_CharT,_Traits>::putback(),  std::basic_istream<_CharT,_Traits>::read(),   std::basic_istream<_CharT,_Traits>::readsome(),  std::basic_istream<_CharT,_Traits>::seekg(),  std::basic_istream<_CharT,_Traits>::seekg(),   std::basic_ostream<_CharT,_Traits>::seekp(),  std::basic_ostream<_CharT,_Traits>::seekp(),  and  std::basic_istream<_CharT,_Traits>::sync().

   staticboolstd::ios_base::sync_with_stdio(bool__sync=true)[static],[inherited]
       Interaction with the standard C I/O objects.

       Parameters__sync Whether to synchronize or not.

       Returns
           True if the standard streams were previously synchronized.

       The synchronization referred to is only that between the standard C facilities  (e.g.,  stdout)  and  the
       standard     C++     objects    (e.g.,    cout).    User-declared    streams    are    unaffected.    See
       https://gcc.gnu.org/onlinedocs/libstdc++/manual/fstreams.html#std.io.filestreams.binary

   template<typename_CharT,typename_Traits>basic_ostream<_CharT,_Traits>*std::basic_ios<_CharT,_Traits>::tie()const[inline]
       Fetches the current tied stream.

       Returns
           A pointer to the tied stream, or NULL if the stream is not tied.

       A  stream may be tied (or synchronized) to a second output stream. When this stream performs any I/O, the
       tied stream is first flushed. For example, std::cin is tied to std::cout.

       Referenced by std::basic_ios<_CharT,_Traits>::copyfmt().

   template<typename_CharT,typename_Traits>basic_ostream<_CharT,_Traits>*std::basic_ios<_CharT,_Traits>::tie(basic_ostream<_CharT,_Traits>*__tiestr)[inline]
       Ties this stream to an output stream.

       Parameters__tiestr The output stream.

       Returns
           The previously tied output stream, or NULL if the stream was not tied.

       This sets up a new tie; see tie() for more.

   voidstd::ios_base::unsetf(fmtflags__mask)[inline],[inherited]
       Clearing format flags.

       Parameters__mask The flags to unset.

       This function clears __mask in the format flags.

   template<typename_CharT,typename_Traits>char_typestd::basic_ios<_CharT,_Traits>::widen(char__c)const[inline]
       Widens characters.

       Parameters__c The character to widen.

       Returns
           The widened character.

       Maps a character of char to a character of char_type.

       Returns the result of

       std::use_facet<ctype<char_type> >(getloc()).widen(c)

       Additional l10n notes are at http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html

       Referenced by std::basic_ios<_CharT,_Traits>::fill().

   streamsizestd::ios_base::width()const[inline],[inherited]
       Flags access.

       Returns
           The minimum field width to generate on output operations.

       Minimumfieldwidth refers to the number of characters.

   streamsizestd::ios_base::width(streamsize__wide)[inline],[inherited]
       Changing flags.

       Parameters__wide The new width value.

       Returns
           The previous value of width().

   staticintstd::ios_base::xalloc()[static],[inherited]
       Access to unique indices.

       Returns
           An integer different from all previous calls.

       This function returns a unique integer every time it is called. It can be used for any  purpose,  but  is
       primarily  intended  to  be  a unique index for the iword and pword functions. The expectation is that an
       application calls xalloc in order to obtain an index in the iword and  pword  arrays  that  can  be  used
       without fear of conflict.

       The  implementation  maintains  a  static  variable  that is incremented and returned on each invocation.
       xalloc is guaranteed to return an index that is safe to use in the iword and pword arrays.

Member Typedef Documentation

template<typename_CharT,typename_Traits>typedefctype<_CharT>std::basic_ios<_CharT,_Traits>::__ctype_type
       These are non-standard types.

   template<typename_CharT,typename_Traits>typedefnum_get<_CharT,istreambuf_iterator<_CharT,_Traits>>std::basic_ios<_CharT,_Traits>::__num_get_type
       These are non-standard types.

   template<typename_CharT,typename_Traits>typedefnum_put<_CharT,ostreambuf_iterator<_CharT,_Traits>>std::basic_ios<_CharT,_Traits>::__num_put_type
       These are non-standard types.

   template<typename_CharT,typename_Traits>typedef_CharTstd::basic_ios<_CharT,_Traits>::char_type
       These are standard types. They permit a standardized way of referring to names of (or names dependent on)
       the template parameters, which are specific to the implementation.

   typedefvoid(*std::ios_base::event_callback)(event__e,ios_base&__b,int__i)[inherited]
       The type of an event callback function.

       Parameters__e One of the members of the event enum.
           __b Reference to the ios_base object.
           __i The integer provided when the callback was registered.

       Event callbacks are user defined functions that get called during several ios_base and basic_ios
       functions, specifically imbue(), copyfmt(), and ~ios().

   typedef_Ios_Fmtflagsstd::ios_base::fmtflags[inherited]
       This is a bitmask type. _Ios_Fmtflags is implementation-defined,butitisvalidtoperformbitwiseoperationsonthesevaluesandexpecttheRightThingtohappen.Definedobjectsoftypefmtflagsare:

       • boolalpha

       • dec

       • fixed

       • hex

       • internal

       • left

       • oct

       • right

       • scientific

       • showbase

       • showpoint

       • showpos

       • skipws

       • unitbuf

       • uppercase

       • adjustfield

       • basefield

       • floatfield

   template<typename_CharT,typename_Traits>typedef_Traits::int_typestd::basic_ios<_CharT,_Traits>::int_type
       These are standard types. They permit a standardized way of referring to names of (or names dependent on)
       the template parameters, which are specific to the implementation.

   typedef_Ios_Iostatestd::ios_base::iostate[inherited]
       This is a bitmask type. _Ios_Iostate is implementation-defined,butitisvalidtoperformbitwiseoperationsonthesevaluesandexpecttheRightThingtohappen.Definedobjectsoftypeiostateare:

       • badbit

       • eofbit

       • failbit

       • goodbit

   template<typename_CharT,typename_Traits>typedef_Traits::off_typestd::basic_ios<_CharT,_Traits>::off_type
       These are standard types. They permit a standardized way of referring to names of (or names dependent on)
       the template parameters, which are specific to the implementation.

   typedef_Ios_Openmodestd::ios_base::openmode[inherited]
       This is a bitmask type. _Ios_Openmode is implementation-defined,butitisvalidtoperformbitwiseoperationsonthesevaluesandexpecttheRightThingtohappen.Definedobjectsoftypeopenmodeare:

       • app

       • ate

       • binary

       • in

       • out

       • trunc

   template<typename_CharT,typename_Traits>typedef_Traits::pos_typestd::basic_ios<_CharT,_Traits>::pos_type
       These are standard types. They permit a standardized way of referring to names of (or names dependent on)
       the template parameters, which are specific to the implementation.

   typedef_Ios_Seekdirstd::ios_base::seekdir[inherited]
       This is an enumerated type. _Ios_Seekdir is implementation-defined.Definedvaluesoftypeseekdirare:

       • beg

       • cur, equivalent to SEEK_CUR in the C standard library.

       • end, equivalent to SEEK_END in the C standard library.

   template<typename_CharT,typename_Traits>typedef_Traitsstd::basic_ios<_CharT,_Traits>::traits_type
       These are standard types. They permit a standardized way of referring to names of (or names dependent on)
       the template parameters, which are specific to the implementation.

Name

       std::basic_ios< _CharT, _Traits > - Template class basic_ios, virtual base class for all stream classes.

Synopsis

       #include <ios>

       Inherits std::ios_base.

       Inherited by std::basic_istream<char> [virtual], std::basic_istream<char,_Traits> [virtual],
       std::basic_istream<_CharT,char_traits<_CharT>> [virtual], std::basic_ostream<char,_Traits>
       [virtual], std::basic_ostream<char> [virtual], std::basic_ostream<_CharT,char_traits<_CharT>>
       [virtual], std::basic_istream<_CharT,_Traits> [virtual], and std::basic_ostream<_CharT,_Traits>
       [virtual].

   PublicTypes
       enum event { erase_event, imbue_event, copyfmt_event }
           The set of events that may be passed to an event callback.
       typedefvoid(* event_callback) (event __e, ios_base &__b, int __i)
           The type of an event callback function.
       typedef _Ios_Fmtflags fmtflags
           This is a bitmask type.
       typedef _Ios_Iostate iostate
           This is a bitmask type.
       typedef _Ios_Openmode openmode
           This is a bitmask type.
       typedef _Ios_Seekdir seekdir
           This is an enumerated type.

           typedef _CharT char_typetypedef _Traits::int_type int_typetypedef _Traits::pos_type pos_typetypedef _Traits::off_type off_typetypedef _Traits traits_typetypedefctype< _CharT > __ctype_typetypedefnum_put< _CharT, ostreambuf_iterator< _CharT, _Traits > > __num_put_typetypedefnum_get< _CharT, istreambuf_iterator< _CharT, _Traits > > __num_get_typePublicMemberFunctionsbasic_ios (basic_streambuf< _CharT, _Traits > *__sb)
           Constructor performs initialization.
       virtual~basic_ios ()
           Empty.
       const locale & _M_getloc () const
           Locale access.
       void_M_setstate (iostate__state)
       bool bad () const
           Fast error checking.
       voidclear (iostate__state=goodbit)
           [Re]sets the error state.
       basic_ios & copyfmt (const basic_ios &__rhs)
           Copies fields of __rhs into this.
       bool eof () const
           Fast error checking.
       iostateexceptions () const
           Throwing exceptions on errors.
       voidexceptions (iostate__except)
           Throwing exceptions on errors.
       bool fail () const
           Fast error checking.
       char_typefill () const
           Retrieves the empty character.
       char_typefill (char_type__ch)
           Sets a new empty character.
       fmtflagsflags () const
           Access to format flags.
       fmtflagsflags (fmtflags__fmtfl)
           Setting new format flags all at once.
       localegetloc () const
           Locale access.
       bool good () const
           Fast error checking.
       localeimbue (const locale &__loc)
           Moves to a new locale.
       long & iword (int __ix)
           Access to integer array.
       char narrow (char_type __c, char __dfault) const
           Squeezes characters.
       streamsizeprecision () const
           Flags access.
       streamsizeprecision (streamsize__prec)
           Changing flags.
       void *& pword (int __ix)
           Access to void pointer array.
       basic_streambuf< _CharT, _Traits > * rdbuf () const
           Accessing the underlying buffer.
       basic_streambuf< _CharT, _Traits > * rdbuf (basic_streambuf< _CharT, _Traits > *__sb)
           Changing the underlying buffer.
       iostaterdstate () const
           Returns the error state of the stream buffer.
       voidregister_callback (event_callback__fn, int __index)
           Add the callback __fn with parameter __index.
       fmtflagssetf (fmtflags__fmtfl)
           Setting new format flags.
       fmtflagssetf (fmtflags__fmtfl, fmtflags __mask)
           Setting new format flags.
       voidsetstate (iostate__state)
           Sets additional flags in the error state.
       basic_ostream< _CharT, _Traits > * tie () const
           Fetches the current tied stream.
       basic_ostream< _CharT, _Traits > * tie (basic_ostream< _CharT, _Traits > *__tiestr)
           Ties this stream to an output stream.
       voidunsetf (fmtflags __mask)
           Clearing format flags.
       char_typewiden (char __c) const
           Widens characters.
       streamsizewidth () const
           Flags access.
       streamsizewidth (streamsize__wide)
           Changing flags.

           operatorbool () const
               The quick-and-easy status check.
           bool operator! () const
               The quick-and-easy status check.

   StaticPublicMemberFunctionsstatic bool sync_with_stdio (bool __sync=true)
           Interaction with the standard C I/O objects.
       static int xalloc ()  throw ()
           Access to unique indices.

   StaticPublicAttributesstatic const openmode__noreplacestatic const fmtflagsadjustfield
           A mask of left|right|internal. Useful for the 2-arg form of setf.
       static const openmodeapp
           Seek to end before each write.
       static const openmodeate
           Open and seek to end immediately after opening.
       static const iostatebadbit
           Indicates a loss of integrity in an input or output sequence (such as an irrecoverable read error
           from a file).
       static const fmtflagsbasefield
           A mask of dec|oct|hex. Useful for the 2-arg form of setf.
       static const seekdirbeg
           Request a seek relative to the beginning of the stream.
       static const openmodebinary
           Perform input and output in binary mode (as opposed to text mode). This is probably not what you
           think it is; see
           https://gcc.gnu.org/onlinedocs/libstdc++/manual/fstreams.html#std.io.filestreams.binary.
       static const fmtflagsboolalpha
           Insert/extract bool in alphabetic rather than numeric format.
       static const seekdircur
           Request a seek relative to the current position within the sequence.
       static const fmtflagsdec
           Converts integer input or generates integer output in decimal base.
       static const seekdirend
           Request a seek relative to the current end of the sequence.
       static const iostateeofbit
           Indicates that an input operation reached the end of an input sequence.
       static const iostatefailbit
           Indicates that an input operation failed to read the expected characters, or that an output operation
           failed to generate the desired characters.
       static const fmtflagsfixed
           Generate floating-point output in fixed-point notation.
       static const fmtflagsfloatfield
           A mask of scientific|fixed. Useful for the 2-arg form of setf.
       static const iostategoodbit
           Indicates all is well.
       static const fmtflagshex
           Converts integer input or generates integer output in hexadecimal base.
       static const openmodein
           Open for input. Default for ifstream and fstream.
       static const fmtflagsinternal
           Adds fill characters at a designated internal point in certain generated output, or identical to
           right if no such point is designated.
       static const fmtflagsleft
           Adds fill characters on the right (final positions) of certain generated output. (I.e., the thing you
           print is flush left.)
       static const fmtflagsoct
           Converts integer input or generates integer output in octal base.
       static const openmodeout
           Open for output. Default for ofstream and fstream.
       static const fmtflagsright
           Adds fill characters on the left (initial positions) of certain generated output. (I.e., the thing
           you print is flush right.)
       static const fmtflagsscientific
           Generates floating-point output in scientific notation.
       static const fmtflagsshowbase
           Generates a prefix indicating the numeric base of generated integer output.
       static const fmtflagsshowpoint
           Generates a decimal-point character unconditionally in generated floating-point output.
       static const fmtflagsshowpos
           Generates a + sign in non-negative generated numeric output.
       static const fmtflagsskipws
           Skips leading white space before certain input operations.
       static const openmodetrunc
           Truncate an existing stream when opening. Default for ofstream.
       static const fmtflagsunitbuf
           Flushes output after each output operation.
       static const fmtflagsuppercase
           Replaces certain lowercase letters with their uppercase equivalents in generated output.

   ProtectedTypes
       enum { _S_local_word_size }

   ProtectedMemberFunctionsbasic_ios ()
           Empty.
       basic_ios (const basic_ios &)=deletevoid_M_cache_locale (const locale &__loc)
       void_M_call_callbacks (event__ev)  throw ()
       void_M_dispose_callbacks (void)  throw ()
       _Words & _M_grow_words (int __index, bool __iword)
       void_M_init ()  throw ()
       void_M_move (ios_base &) noexcept
       void_M_swap (ios_base &__rhs) noexcept
       voidinit (basic_streambuf< _CharT, _Traits > *__sb)
           All setup is performed here.
       voidmove (basic_ios &&__rhs)
       voidmove (basic_ios &__rhs)
       basic_ios & operator= (const basic_ios &)=deletevoidset_rdbuf (basic_streambuf< _CharT, _Traits > *__sb)
       voidswap (basic_ios &__rhs) noexcept

   ProtectedAttributes
       _Callback_list * _M_callbacks
       const __ctype_type * _M_ctypeiostate_M_exceptionchar_type_M_fill
       bool _M_fill_initfmtflags_M_flagslocale_M_ios_locale
       _Words _M_local_word [_S_local_word_size]
       const __num_get_type * _M_num_get
       const __num_put_type * _M_num_putstreamsize_M_precisionbasic_streambuf< _CharT, _Traits > * _M_streambufiostate_M_streambuf_statebasic_ostream< _CharT, _Traits > * _M_tiestreamsize_M_width
       _Words * _M_word
       int _M_word_size
       _Words _M_word_zero

See Also