W3cubDocs

std::println

Defined in header `<print>`
template< class... Args > void println( std::FILE* stream, std::format_string<Args...> fmt, Args&&... args );	(1)	(since C++23)
template< class... Args > void println( std::format_string<Args...> fmt, Args&&... args );	(2)	(since C++23)

Format args according to the format string fmt with appended '\n' (which means that each output ends with a new-line), and print the result to a stream.

1) Equivalent to:

std::print(stream, "{}\n", std::format(fmt, std::forward<Args>(args)...));

2) same as (1) when stream is equal to the standard C output stream stdout, i.e.

std::println(stdout, fmt, std::forward<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

stream - output file stream to write to

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-ids 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.

For basic types and standard string types, the format specification is interpreted as standard format specification.
For chrono types, the format specification is interpreted as chrono format specification.
For std::thread::id, the format specification is interpreted as thread id format specification.
For other formattable types, the format specification is determined by user-defined formatter specializations.

args... - arguments to be formatted

Return value

(none).

Exceptions

std::bad_alloc on allocation failure.
std::system_error, if writing to the stream fails.
Propagates any exception thrown by used formatters, e.g. std::format_error.

Notes

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

Example

#include <print>
 
int main()
{
    // Each call to std::println ends with new-line
    std::println("Please");
    std::println("enter");
 
    std::print("pass");
    std::print("word");
 
    std::println(""); // same effect as std::print("\n");
}

Output:

Please
enter
password