Provided by: libstdc++-9-doc_9.4.0-1ubuntu1~20.04.2_all 
NAME
std::basic_ostream< _CharT, _Traits > - Template class basic_ostream.
SYNOPSIS
Inherited by std::basic_ofstream< _CharT, _Traits >.
Classes
class sentry
Performs setup work for output streams.
Public Types
typedef ctype< _CharT > __ctype_type
typedef basic_ios< _CharT, _Traits > __ios_type
typedef num_put< _CharT, ostreambuf_iterator< _CharT, _Traits > > __num_put_type
typedef basic_ostream< _CharT, _Traits > __ostream_type
typedef basic_streambuf< _CharT, _Traits > __streambuf_type
typedef _CharT char_type
typedef _Traits::int_type int_type
typedef _Traits::off_type off_type
typedef _Traits::pos_type pos_type
typedef _Traits traits_type
Public Member Functions
basic_ostream (__streambuf_type *__sb)
Base constructor.
virtual ~basic_ostream ()
Base destructor.
template<typename _ValueT > basic_ostream< _CharT, _Traits > & _M_insert (_ValueT __v)
__ostream_type & flush ()
Synchronizing the stream buffer.
__ostream_type & operator<< (__streambuf_type *__sb)
Extracting from another streambuf.
__ostream_type & operator<< (const void *__p)
Pointer arithmetic inserters.
__ostream_type & seekp (off_type, ios_base::seekdir)
Changing the current write position.
__ostream_type & seekp (pos_type)
Changing the current write position.
pos_type tellp ()
Getting the current write position.
Protected Member Functions
basic_ostream (basic_iostream< _CharT, _Traits > &)
basic_ostream (basic_ostream &&__rhs)
basic_ostream (const basic_ostream &)=delete
template<typename _ValueT > __ostream_type & _M_insert (_ValueT __v)
basic_ostream & operator= (basic_ostream &&__rhs)
basic_ostream & operator= (const basic_ostream &)=delete
void swap (basic_ostream &__rhs)
Friends
class sentry
Detailed Description
template<typename _CharT, typename _Traits>
class std::basic_ostream< _CharT, _Traits >" Template class basic_ostream.
Template Parameters
_CharT Type of character stream.
_Traits Traits for character type, defaults to char_traits<_CharT>.
This is the base class for all output streams. It provides text formatting of all builtin
types, and communicates with any class derived from basic_streambuf to do the actual
output.
Definition at line 86 of file iosfwd.
Constructor & Destructor Documentation
template<typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits
>::basic_ostream (__streambuf_type * __sb) [inline], [explicit]
Base constructor. This ctor is almost never called by the user directly, rather from
derived classes' initialization lists, which pass a pointer to their own stream buffer.
Definition at line 84 of file ostream.
template<typename _CharT , typename _Traits > virtual std::basic_ostream< _CharT, _Traits
>::~basic_ostream () [inline], [virtual]
Base destructor. This does very little apart from providing a virtual base dtor.
Definition at line 93 of file ostream.
Member Function Documentation
template<typename _CharT , typename _Traits > void std::basic_ostream< _CharT, _Traits
>::_M_write (const char_type * __s, streamsize __n) [inline]
Core write functionality, without sentry.
Parameters
__s The array to insert.
__n Maximum number of characters to insert.
Definition at line 317 of file ostream.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > &
std::basic_ostream< _CharT, _Traits >::flush
Synchronizing the stream buffer.
Returns
*this
If rdbuf() is a null pointer, changes nothing.
Otherwise, calls rdbuf()->pubsync(), and if that returns -1, sets badbit.
Definition at line 211 of file ostream.tcc.
Referenced by std::basic_ostream< _CharT, _Traits >::sentry::sentry().
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (__ios_type &(*)(__ios_type &) __pf) [inline]
Interface for manipulators. Manipulators such as std::endl and std::hex use these
functions in constructs like 'std::cout << std::endl'. For more information, see the
iomanip header.
Definition at line 117 of file ostream.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (__ostream_type &(*)(__ostream_type &) __pf) [inline]
Interface for manipulators. Manipulators such as std::endl and std::hex use these
functions in constructs like 'std::cout << std::endl'. For more information, see the
iomanip header.
Definition at line 108 of file ostream.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > &
std::basic_ostream< _CharT, _Traits >::operator<< (__streambuf_type * __sb)
Extracting from another streambuf.
Parameters
__sb A pointer to a streambuf
This function behaves like one of the basic arithmetic extractors, in that it also
constructs a sentry object and has the same error handling behavior.
If __sb is NULL, the stream will set failbit in its error state.
Characters are extracted from __sb and inserted into *this until one of the following
occurs:
• the input stream reaches end-of-file,
• insertion into the output sequence fails (in this case, the character that would have
been inserted is not extracted), or
• an exception occurs while getting a character from __sb, which sets failbit in the error
state
If the function inserts no characters, failbit is set.
Definition at line 120 of file ostream.tcc.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (bool __n) [inline]
Integer arithmetic inserters.
Parameters
__n A variable of builtin integral type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 174 of file ostream.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (const void * __p) [inline]
Pointer arithmetic inserters.
Parameters
__p A variable of pointer type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 245 of file ostream.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (double __f) [inline]
Floating point arithmetic inserters.
Parameters
__f A variable of builtin floating point type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 220 of file ostream.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (float __f) [inline]
Floating point arithmetic inserters.
Parameters
__f A variable of builtin floating point type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 224 of file ostream.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > &
std::basic_ostream< _CharT, _Traits >::operator<< (int __n)
Integer arithmetic inserters.
Parameters
__n A variable of builtin integral type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 106 of file ostream.tcc.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (ios_base &(*)(ios_base &) __pf) [inline]
Interface for manipulators. Manipulators such as std::endl and std::hex use these
functions in constructs like 'std::cout << std::endl'. For more information, see the
iomanip header.
Definition at line 127 of file ostream.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (long __n) [inline]
Integer arithmetic inserters.
Parameters
__n A variable of builtin integral type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 166 of file ostream.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (long double __f) [inline]
Floating point arithmetic inserters.
Parameters
__f A variable of builtin floating point type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 232 of file ostream.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (long long __n) [inline]
Integer arithmetic inserters.
Parameters
__n A variable of builtin integral type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 201 of file ostream.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > &
std::basic_ostream< _CharT, _Traits >::operator<< (short __n)
Integer arithmetic inserters.
Parameters
__n A variable of builtin integral type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 92 of file ostream.tcc.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (unsigned int __n) [inline]
Integer arithmetic inserters.
Parameters
__n A variable of builtin integral type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 192 of file ostream.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (unsigned long __n) [inline]
Integer arithmetic inserters.
Parameters
__n A variable of builtin integral type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 170 of file ostream.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (unsigned long long __n) [inline]
Integer arithmetic inserters.
Parameters
__n A variable of builtin integral type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 205 of file ostream.
template<typename _CharT , typename _Traits > __ostream_type& std::basic_ostream< _CharT,
_Traits >::operator<< (unsigned short __n) [inline]
Integer arithmetic inserters.
Parameters
__n A variable of builtin integral type.
Returns
*this if successful
These functions use the stream's current locale (specifically, the num_get facet) to
perform numeric formatting.
Definition at line 181 of file ostream.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > &
std::basic_ostream< _CharT, _Traits >::put (char_type __c)
Simple insertion.
Parameters
__c The character to insert.
Returns
*this
Tries to insert __c.
Note
This function is not overloaded on signed char and unsigned char.
Definition at line 149 of file ostream.tcc.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > &
std::basic_ostream< _CharT, _Traits >::seekp (off_type __off, ios_base::seekdir __dir)
Changing the current write position.
Parameters
__off A file offset object.
__dir The direction in which to seek.
Returns
*this
If fail() is not true, calls rdbuf()->pubseekoff(off,dir). If that function fails, sets
failbit.
Definition at line 290 of file ostream.tcc.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > &
std::basic_ostream< _CharT, _Traits >::seekp (pos_type __pos)
Changing the current write position.
Parameters
__pos A file position object.
Returns
*this
If fail() is not true, calls rdbuf()->pubseekpos(pos). If that function fails, sets
failbit.
Definition at line 258 of file ostream.tcc.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits >::pos_type
std::basic_ostream< _CharT, _Traits >::tellp
Getting the current write position.
Returns
A file position object.
If fail() is not false, returns pos_type(-1) to indicate failure. Otherwise returns
rdbuf()->pubseekoff(0,cur,out).
Definition at line 237 of file ostream.tcc.
template<typename _CharT , typename _Traits > basic_ostream< _CharT, _Traits > &
std::basic_ostream< _CharT, _Traits >::write (const char_type * __s, streamsize __n)
Character string insertion.
Parameters
__s The array to insert.
__n Maximum number of characters to insert.
Returns
*this
Characters are copied from __s and inserted into the stream until one of the following
happens:
• __n characters are inserted
• inserting into the output sequence fails (in this case, badbit will be set in the
stream's error state)
Note
This function is not overloaded on signed char and unsigned char.
Definition at line 183 of file ostream.tcc.
Author
Generated automatically by Doxygen for libstdc++ from the source code.
libstdc++ Mon Oct 24 20std::basic_ostream< _CharT, _Traits >(3cxx)