Namespaces
Variants
Views
Actions

print(std::ostream)

From cppreference.com
< cpp‎ | io‎ | basic ostream
 
 
 
 
Defined in header <ostream>
template< class... Args >
void print( std::ostream& os, std::format_string<Args...> fmt, Args&&... args );
(since C++23)

Formats args according to the format string fmt, and inserts the result into os stream.

If the ordinary literal encoding is UTF-8, equivalent to:

The behavior is undefined if std::formatter<Ti, char> does not meet the BasicFormatter requirements for any Ti in Args (as required by std::make_format_args).

Contents

[edit] Parameters

os - output stream to insert data into
fmt - an object that represents the format string. The format string consists of
  • ordinary characters (except { and }), which are copied unchanged to the output,
  • escape sequences {{ and }}, which are replaced with { and } respectively in the output, and
  • replacement fields.

Each replacement field has the following format:

{ arg-id (optional) } (1)
{ arg-id (optional) : format-spec } (2)
1) replacement field without a format specification
2) replacement field with a format specification
arg-id - specifies the index of the argument in args whose value is to be used for formatting; if it is omitted, the arguments are used in order.

The arg-id s in a format string must all be present or all be omitted. Mixing manual and automatic indexing is an error.

format-spec - the format specification defined by the std::formatter specialization for the corresponding argument. Cannot start with }.

(since C++23)
(since C++26)
  • For other formattable types, the format specification is determined by user-defined formatter specializations.
args... - arguments to be formatted

[edit] Return value

(none)

[edit] Exceptions

[edit] Notes

Feature-test macro Value Std Feature
__cpp_lib_print 202207L (C++23) Formatted output
__cpp_lib_format 202207L (C++23) Exposing std::basic_format_string

[edit] Example

#include <array>
#include <cctype>
#include <cstdio>
#include <format>
#include <numbers>
#include <ranges>
#include <sstream>
 
int main()
{
    std::array<char, 24> buf;
    std::format_to(buf.begin(), "{:.15f}", std::numbers::sqrt2);
 
    unsigned num{}, sum{};
 
    auto v = buf
           | std::views::filter(isdigit)
           | std::views::transform([](char x) { return x - '0'; })
           | std::views::take_while([&sum](char) { return sum < 42; });
 
    for (auto n : v)
        sum += n, ++num;
 
    std::stringstream stream;
 
#ifdef __cpp_lib_print
    std::print(stream,
#else
    stream << std::format(
#endif
        "√2 = {}...\n"
        "The sum of its first {} digits is {}{}",
        std::numbers::sqrt2, num, sum, '.'
    );
 
    std::puts(stream.str().data());
}

Output:

√2 = 1.4142135623730951...
The sum of its first 13 digits is 42.

[edit] See also

outputs formatted representation of the arguments with appended '\n'
(function template) [edit]
(C++23)
prints to stdout or a file stream using formatted representation of the arguments
(function template) [edit]
(C++20)
stores formatted representation of the arguments in a new string
(function template) [edit]