30 Input/output library [input.output]

30.7 Formatting and manipulators [iostream.format]

30.7.5 Output streams [output.streams]

1
#
The header <ostream> defines a type and several function signatures that control output to a stream buffer along with a function template that inserts into stream rvalues.

30.7.5.1 Class template basic_­ostream [ostream]

namespace std {
  template <class charT, class traits = char_traits<charT>>
  class basic_ostream : virtual public basic_ios<charT, traits> {
  public:
    // types (inherited from basic_­ios ([ios])):
    using char_type   = charT;
    using int_type    = typename traits::int_type;
    using pos_type    = typename traits::pos_type;
    using off_type    = typename traits::off_type;
    using traits_type = traits;

    // [ostream.cons], constructor/destructor
    explicit basic_ostream(basic_streambuf<char_type, traits>* sb);
    virtual ~basic_ostream();

    // [ostream::sentry], prefix/suffix
    class sentry;

    // [ostream.formatted], formatted output
    basic_ostream<charT, traits>&
      operator<<(basic_ostream<charT, traits>& (*pf)(basic_ostream<charT, traits>&));
    basic_ostream<charT, traits>&
      operator<<(basic_ios<charT, traits>& (*pf)(basic_ios<charT, traits>&));
    basic_ostream<charT, traits>&
      operator<<(ios_base& (*pf)(ios_base&));

    basic_ostream<charT, traits>& operator<<(bool n);
    basic_ostream<charT, traits>& operator<<(short n);
    basic_ostream<charT, traits>& operator<<(unsigned short n);
    basic_ostream<charT, traits>& operator<<(int n);
    basic_ostream<charT, traits>& operator<<(unsigned int n);
    basic_ostream<charT, traits>& operator<<(long n);
    basic_ostream<charT, traits>& operator<<(unsigned long n);
    basic_ostream<charT, traits>& operator<<(long long n);
    basic_ostream<charT, traits>& operator<<(unsigned long long n);
    basic_ostream<charT, traits>& operator<<(float f);
    basic_ostream<charT, traits>& operator<<(double f);
    basic_ostream<charT, traits>& operator<<(long double f);

    basic_ostream<charT, traits>& operator<<(const void* p);
    basic_ostream<charT, traits>& operator<<(nullptr_t);
    basic_ostream<charT, traits>& operator<<(basic_streambuf<char_type, traits>* sb);

    // [ostream.unformatted], unformatted output
    basic_ostream<charT, traits>& put(char_type c);
    basic_ostream<charT, traits>& write(const char_type* s, streamsize n);

    basic_ostream<charT, traits>& flush();

    // [ostream.seeks], seeks
    pos_type tellp();
    basic_ostream<charT, traits>& seekp(pos_type);
    basic_ostream<charT, traits>& seekp(off_type, ios_base::seekdir);

  protected:
    // [ostream.cons], copy/move constructor
    basic_ostream(const basic_ostream& rhs) = delete;
    basic_ostream(basic_ostream&& rhs);

    // [ostream.assign], assign and swap
    basic_ostream& operator=(const basic_ostream& rhs) = delete;
    basic_ostream& operator=(basic_ostream&& rhs);
    void swap(basic_ostream& rhs);
  };

  // [ostream.inserters.character], character inserters
  template<class charT, class traits>
    basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>&, charT);
  template<class charT, class traits>
    basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>&, char);
  template<class traits>
    basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>&, char);

  template<class traits>
    basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>&, signed char);
  template<class traits>
    basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>&, unsigned char);

  template<class charT, class traits>
    basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>&, const charT*);
  template<class charT, class traits>
    basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>&, const char*);
  template<class traits>
    basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>&, const char*);

  template<class traits>
    basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>&, const signed char*);
  template<class traits>
    basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>&, const unsigned char*);
}
1
#
The class template basic_­ostream defines a number of member function signatures that assist in formatting and writing output to output sequences controlled by a stream buffer.
2
#
Two groups of member function signatures share common properties: the formatted output functions (or inserters) and the unformatted output functions. Both groups of output functions generate (or insert) output characters by actions equivalent to calling rdbuf()->sputc(int_­type).
They may use other public members of basic_­ostream except that they shall not invoke any virtual members of rdbuf() except overflow(), xsputn(), and sync().
3
#
If one of these called functions throws an exception, then unless explicitly noted otherwise the output function sets badbit in error state.
If badbit is on in exceptions(), the output function rethrows the exception without completing its actions, otherwise it does not throw anything and treat as an error.

30.7.5.1.1 basic_­ostream constructors [ostream.cons]

🔗
explicit basic_ostream(basic_streambuf<charT, traits>* sb);
1
#
Effects: Constructs an object of class basic_­ostream, initializing the base class subobject with basic_­ios<charT, traits>​::​init(sb) ([basic.ios.cons]).
2
#
Postconditions: rdbuf() == sb.
🔗
basic_ostream(basic_ostream&& rhs);
3
#
Effects: Move constructs from the rvalue rhs.
This is accomplished by default constructing the base class and calling basic_­ios<charT, traits>​::​move(rhs) to initialize the base class.
🔗
virtual ~basic_ostream();
4
#
Effects: Destroys an object of class basic_­ostream.
5
#
Remarks: Does not perform any operations on rdbuf().

30.7.5.1.2 Class basic_­ostream assign and swap [ostream.assign]

🔗
basic_ostream& operator=(basic_ostream&& rhs);
1
#
Effects: As if by swap(rhs).
2
#
Returns: *this.
🔗
void swap(basic_ostream& rhs);
3
#
Effects: Calls basic_­ios<charT, traits>​::​swap(rhs).

30.7.5.1.3 Class basic_­ostream​::​sentry [ostream::sentry]

namespace std {
  template <class charT, class traits = char_traits<charT>>
  class basic_ostream<charT, traits>::sentry {
    bool ok_; // exposition only
  public:
    explicit sentry(basic_ostream<charT, traits>& os);
    ~sentry();
    explicit operator bool() const { return ok_; }

    sentry(const sentry&) = delete;
    sentry& operator=(const sentry&) = delete;
  };
}
1
#
The class sentry defines a class that is responsible for doing exception safe prefix and suffix operations.
🔗
explicit sentry(basic_ostream<charT, traits>& os);
2
#
If os.good() is nonzero, prepares for formatted or unformatted output.
If os.tie() is not a null pointer, calls os.tie()->flush().318
3
#
If, after any preparation is completed, os.good() is true, ok_­ == true otherwise, ok_­ == false.
During preparation, the constructor may call setstate(failbit) (which may throw ios_­base​::​​failure ([iostate.flags]))319
🔗
~sentry();
4
#
If (os.flags() & ios_­base​::​unitbuf) && !uncaught_­exceptions() && os.good() is true, calls os.rdbuf()->pubsync().
If that function returns -1, sets badbit in os.rdstate() without propagating an exception.
🔗
explicit operator bool() const;
5
#
Effects: Returns ok_­.
318)
The call os.tie()->flush() does not necessarily occur if the function can determine that no synchronization is necessary.
319)
The sentry constructor and destructor can also perform additional implementation-dependent operations.

30.7.5.1.4 basic_­ostream seek members [ostream.seeks]

1
#
Each seek member function begins execution by constructing an object of class sentry.
It returns by destroying the sentry object.
🔗
pos_type tellp();
2
#
Returns: If fail() != false, returns pos_­type(-1) to indicate failure.
Otherwise, returns rdbuf()->​pubseekoff(​0, cur, out).
🔗
basic_ostream<charT, traits>& seekp(pos_type pos);
3
#
Effects: If fail() != true, executes rdbuf()->pubseekpos(pos, ios_­base​::​out).
In case of failure, the function calls setstate(failbit) (which may throw ios_­base​::​failure).
4
#
Returns: *this.
🔗
basic_ostream<charT, traits>& seekp(off_type off, ios_base::seekdir dir);
5
#
Effects: If fail() != true, executes rdbuf()->pubseekoff(off, dir, ios_­base​::​out).
In case of failure, the function calls setstate(failbit) (which may throw ios_­base​::​failure).
6
#
Returns: *this.

30.7.5.2 Formatted output functions [ostream.formatted]

30.7.5.2.1 Common requirements [ostream.formatted.reqmts]

1
#
Each formatted output function begins execution by constructing an object of class sentry.
If this object returns true when converted to a value of type bool, the function endeavors to generate the requested output.
If the generation fails, then the formatted output function does setstate(ios_­base​::​failbit), which might throw an exception.
If an exception is thrown during output, then ios​::​badbit is turned on320 in *this's error state.
If (exceptions()&badbit) != 0 then the exception is rethrown.
Whether or not an exception is thrown, the sentry object is destroyed before leaving the formatted output function.
If no exception is thrown, the result of the formatted output function is *this.
2
#
The descriptions of the individual formatted output functions describe how they perform output and do not mention the sentry object.
3
#
If a formatted output function of a stream os determines padding, it does so as follows.
Given a charT character sequence seq where charT is the character type of the stream, if the length of seq is less than os.width(), then enough copies of os.fill() are added to this sequence as necessary to pad to a width of os.width() characters.
If (os.flags() & ios_­base​::​adjustfield) == ios_­base​::​left is true, the fill characters are placed after the character sequence; otherwise, they are placed before the character sequence.
320)
without causing an ios​::​failure to be thrown.

30.7.5.2.2 Arithmetic inserters [ostream.inserters.arithmetic]

🔗
operator<<(bool val); operator<<(short val); operator<<(unsigned short val); operator<<(int val); operator<<(unsigned int val); operator<<(long val); operator<<(unsigned long val); operator<<(long long val); operator<<(unsigned long long val); operator<<(float val); operator<<(double val); operator<<(long double val); operator<<(const void* val);
1
#
Effects: The classes num_­get<> and num_­put<> handle locale-dependent numeric formatting and parsing.
These inserter functions use the imbued locale value to perform numeric formatting.
When val is of type bool, long, unsigned long, long long, unsigned long long, double, long double, or const void*, the formatting conversion occurs as if it performed the following code fragment: 
bool failed = use_facet<
  num_put<charT, ostreambuf_iterator<charT, traits>>
    >(getloc()).put(*this, *this, fill(), val).failed();
When val is of type short the formatting conversion occurs as if it performed the following code fragment: 
ios_base::fmtflags baseflags = ios_base::flags() & ios_base::basefield;
bool failed = use_facet<
  num_put<charT, ostreambuf_iterator<charT, traits>>
    >(getloc()).put(*this, *this, fill(),
    baseflags == ios_base::oct || baseflags == ios_base::hex
      ? static_cast<long>(static_cast<unsigned short>(val))
      : static_cast<long>(val)).failed();
When val is of type int the formatting conversion occurs as if it performed the following code fragment: 
ios_base::fmtflags baseflags = ios_base::flags() & ios_base::basefield;
bool failed = use_facet<
  num_put<charT, ostreambuf_iterator<charT, traits>>
    >(getloc()).put(*this, *this, fill(),
    baseflags == ios_base::oct || baseflags == ios_base::hex
      ? static_cast<long>(static_cast<unsigned int>(val))
      : static_cast<long>(val)).failed();
When val is of type unsigned short or unsigned int the formatting conversion occurs as if it performed the following code fragment: 
bool failed = use_facet<
  num_put<charT, ostreambuf_iterator<charT, traits>>
    >(getloc()).put(*this, *this, fill(),
      static_cast<unsigned long>(val)).failed();
When val is of type float the formatting conversion occurs as if it performed the following code fragment: 
bool failed = use_facet<
  num_put<charT, ostreambuf_iterator<charT, traits>>
    >(getloc()).put(*this, *this, fill(),
      static_cast<double>(val)).failed();
2
#
The first argument provides an object of the ostreambuf_­iterator<> class which is an iterator for class basic_­ostream<>.
It bypasses ostreams and uses streambufs directly.
Class locale relies on these types as its interface to iostreams, since for flexibility it has been abstracted away from direct dependence on ostream.
The second parameter is a reference to the base class subobject of type ios_­base.
It provides formatting specifications such as field width, and a locale from which to obtain other facets.
If failed is true then does setstate(badbit), which may throw an exception, and returns.
3
#
Returns: *this.

30.7.5.2.3 basic_­ostream​::​operator<< [ostream.inserters]

🔗
basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>& (*pf)(basic_ostream<charT, traits>&));
1
#
Effects: None.
Does not behave as a formatted output function (as described in [ostream.formatted.reqmts]).
2
#
Returns: pf(*this).321
🔗
basic_ostream<charT, traits>& operator<<(basic_ios<charT, traits>& (*pf)(basic_ios<charT, traits>&));
3
#
Effects: Calls pf(*this).
This inserter does not behave as a formatted output function (as described in [ostream.formatted.reqmts]).
4
#
Returns: *this.322
🔗
basic_ostream<charT, traits>& operator<<(ios_base& (*pf)(ios_base&));
5
#
Effects: Calls pf(*this).
This inserter does not behave as a formatted output function (as described in [ostream.formatted.reqmts]).
6
#
Returns: *this.
🔗
basic_ostream<charT, traits>& operator<<(basic_streambuf<charT, traits>* sb);
7
#
Effects: Behaves as an unformatted output function ([ostream.unformatted]).
After the sentry object is constructed, if sb is null calls setstate(badbit) (which may throw ios_­base​::​failure).
8
#
Gets characters from sb and inserts them in *this.
Characters are read from sb and inserted until any of the following occurs:
  • (8.1)
    end-of-file occurs on the input sequence;
  • (8.2)
    inserting in the output sequence fails (in which case the character to be inserted is not extracted);
  • (8.3)
    an exception occurs while getting a character from sb.
9
#
If the function inserts no characters, it calls setstate(failbit) (which may throw ios_­base​::​​failure ([iostate.flags])).
If an exception was thrown while extracting a character, the function sets failbit in error state, and if failbit is on in exceptions() the caught exception is rethrown.
10
#
Returns: *this.
🔗
basic_ostream<charT, traits>& operator<<(nullptr_t);
11
#
Effects: Equivalent to: 
return *this << s;
where s is an implementation-defined NTCTS ([defns.ntcts]).
321)
See, for example, the function signature endl(basic_­ostream&) ([ostream.manip]).
322)
See, for example, the function signature dec(ios_­base&) ([basefield.manip]).

30.7.5.2.4 Character inserter function templates [ostream.inserters.character]

🔗
template<class charT, class traits> basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>& out, charT c); template<class charT, class traits> basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>& out, char c); // specialization template<class traits> basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>& out, char c); // signed and unsigned template<class traits> basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>& out, signed char c); template<class traits> basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>& out, unsigned char c);
1
#
Effects: Behaves as a formatted output function ([ostream.formatted.reqmts]) of out.
Constructs a character sequence seq.
If c has type char and the character type of the stream is not char, then seq consists of out.widen(c); otherwise seq consists of c.
Determines padding for seq as described in [ostream.formatted.reqmts].
Inserts seq into out.
Calls os.width(0).
2
#
Returns: out.
🔗
template<class charT, class traits> basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>& out, const charT* s); template<class charT, class traits> basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>& out, const char* s); template<class traits> basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>& out, const char* s); template<class traits> basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>& out, const signed char* s); template<class traits> basic_ostream<char, traits>& operator<<(basic_ostream<char, traits>& out, const unsigned char* s);
3
#
Requires: s shall not be a null pointer.
4
#
Effects: Behaves like a formatted inserter (as described in [ostream.formatted.reqmts]) of out.
Creates a character sequence seq of n characters starting at s, each widened using out.widen() ([basic.ios.members]), where n is the number that would be computed as if by:
  • (4.1)
    traits​::​length(s) for the overload where the first argument is of type basic_­ostream<charT, traits>& and the second is of type const charT*, and also for the overload where the first argument is of type basic_­ostream<char, traits>& and the second is of type const char*,
  • (4.2)
    char_­traits<char>​::​length(s) for the overload where the first argument is of type basic_­ostream<charT, traits>& and the second is of type const char*,
  • (4.3)
    traits​::​length(reinterpret_­cast<const char*>(s)) for the other two overloads.
Determines padding for seq as described in [ostream.formatted.reqmts].
Inserts seq into out.
Calls width(0).
5
#
Returns: out.

30.7.5.3 Unformatted output functions [ostream.unformatted]

1
#
Each unformatted output function begins execution by constructing an object of class sentry.
If this object returns true, while converting to a value of type bool, the function endeavors to generate the requested output.
If an exception is thrown during output, then ios​::​badbit is turned on323 in *this's error state.
If (exceptions() & badbit) != 0 then the exception is rethrown.
In any case, the unformatted output function ends by destroying the sentry object, then, if no exception was thrown, returning the value specified for the unformatted output function.
🔗
basic_ostream<charT, traits>& put(char_type c);
2
#
Effects: Behaves as an unformatted output function (as described above).
After constructing a sentry object, inserts the character c, if possible.324
3
#
Otherwise, calls setstate(badbit) (which may throw ios_­base​::​failure ([iostate.flags])).
4
#
Returns: *this.
🔗
basic_ostream& write(const char_type* s, streamsize n);
5
#
Effects: Behaves as an unformatted output function (as described above).
After constructing a sentry object, obtains characters to insert from successive locations of an array whose first element is designated by s.325
Characters are inserted until either of the following occurs:
  • (5.1)
    n characters are inserted;
  • (5.2)
    inserting in the output sequence fails (in which case the function calls setstate(badbit), which may throw ios_­base​::​failure ([iostate.flags])).
6
#
Returns: *this.
🔗
basic_ostream& flush();
7
#
Effects: Behaves as an unformatted output function (as described above).
If rdbuf() is not a null pointer, constructs a sentry object.
If this object returns true when converted to a value of type bool the function calls rdbuf()->pubsync().
If that function returns -1 calls setstate(badbit) (which may throw ios_­base​::​failure ([iostate.flags])).
Otherwise, if the sentry object returns false, does nothing.
8
#
Returns: *this.
323)
without causing an ios​::​failure to be thrown.
324)
Note that this function is not overloaded on types signed char and unsigned char.
325)
Note that this function is not overloaded on types signed char and unsigned char.

30.7.5.4 Standard basic_­ostream manipulators [ostream.manip]

🔗
template <class charT, class traits> basic_ostream<charT, traits>& endl(basic_ostream<charT, traits>& os);
1
#
Effects: Calls os.put(os.widen('\n')), then os.flush().
2
#
Returns: os.
🔗
template <class charT, class traits> basic_ostream<charT, traits>& ends(basic_ostream<charT, traits>& os);
3
#
Effects: Inserts a null character into the output sequence: calls os.put(charT()).
4
#
Returns: os.
🔗
template <class charT, class traits> basic_ostream<charT, traits>& flush(basic_ostream<charT, traits>& os);
5
#
Effects: Calls os.flush().
6
#
Returns: os.

30.7.5.5 Rvalue stream insertion [ostream.rvalue]

🔗
template <class charT, class traits, class T> basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>&& os, const T& x);
1
#
Effects: As if by: os << x;
2
#
Returns: os.
3
#
Remarks: This function shall not participate in overload resolution unless the expression os << x is well-formed.