std::vprint_nonunicode(std::ostream) - cppreference.com

From cppreference.com

void vprint_nonunicode( std::ostream& os, std::string_view fmt, std::format_args args );

(since C++23)

Behaves as FormattedOutputFunction (except that some details of error reporting differ).

Performs the following operations in order:

  1. First, constructs and checks the sentry object.
  2. Then, initializes an automatic variable as if by std::string out = std::vformat(os.getloc(), fmt, args);.
  3. Finally, inserts the character sequence [out.begin()out.end()) into os.

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)
  • For other formattable types, the format specification is determined by user-defined formatter specializations.
args - arguments to be formatted

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 std::ios_base::badbit in the error state of os.
  • May throw std::ios_base::failure caused by os.setstate(ios_base::badbit) which is called if an insertion into os fails.

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

See also