| 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:
-
. Otherwise,std::vprint_unicode(os, fmt.get(), std::make_format_args(args...)); -
.std::vprint_nonunicode(os, fmt.get(), std::make_format_args(args...));
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).
Parameters
| os | - | output stream to insert data into | ||||||||||||||||||||||||||||||||||||||||||||||
| fmt | - | an object that represents the format string. The format string consists of
Each replacement field has the following format:
1) replacement field without a format specification
2) replacement field with a format specification
| ||||||||||||||||||||||||||||||||||||||||||||||
| args... | - | arguments to be formatted | ||||||||||||||||||||||||||||||||||||||||||||||
Return value
(none)
Exceptions
- std::bad_alloc on allocation failure.
- Propagate any exception thrown by any formatter, e.g. std::format_error, without regard to the value of
os.exceptions()and without turning on ios_base::badbit in the error state ofos. - May throw ios_base::failure caused by
os.setstate(ios_base::badbit)which is called if an insertion intoosfails.
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 |
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());
}√2 = 1.4142135623730951...
The sum of its first 13 digits is 42.See also
| (C++23) |
outputs formatted representation of the arguments with appended '\n' (function template) |
| (C++23) |
prints to stdout or a file stream using formatted representation of the arguments (function template) |
| (C++20) |
stores formatted representation of the arguments in a new string (function template) |
Content from this page on cppreference.com, licensed under CC-BY-SA 3.0 and GFDL. Modified: restyled, site navigation removed, code windows added. Offline snapshot of 9 February 2025.