Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/utility/format/runtime format"

From cppreference.com
< cpp‎ | utility‎ | format
m (added more description of its return type and more notes)
m (added missing noexcept)
Line 5: Line 5:
 
{{dcl header|format}}
 
{{dcl header|format}}
 
{{dcl|num=1|since=c++26|1=
 
{{dcl|num=1|since=c++26|1=
−
/*runtime-format-string*/<char> runtime_format( std::string_view fmt );
+
/*runtime-format-string*/<char> runtime_format( std::string_view fmt ) noexcept;
 
}}
 
}}
 
{{dcl|num=2|since=c++26|1=
 
{{dcl|num=2|since=c++26|1=
−
/*runtime-format-string*/<wchar_t> runtime_format( std::wstring_view fmt );
+
/*runtime-format-string*/<wchar_t> runtime_format( std::wstring_view fmt ) noexcept;
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}

Revision as of 06:31, 19 December 2023

 
C++
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
Formatting library
Standard format specification
Formatting functions
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
Format strings
(C++20)(C++20)(C++20)
runtime_format
(C++26)
Formatting concepts
(C++23)
Formatter
(C++20)
(C++23)
(C++23)
(C++23)
(C++23)
(C++20)(C++20)(C++20)
(C++20)(C++20)(C++20)
(C++23)
(C++23)
Formatting arguments
(C++20)
(C++20)
(C++20)(C++20)(C++20)
(C++20) (deprecated in C++26)
(C++20)(C++20)
Format error
(C++20)
 
Defined in header <format>
/*runtime-format-string*/<char> runtime_format( std::string_view fmt ) noexcept;
 (1) (since C++26)
/*runtime-format-string*/<wchar_t> runtime_format( std::wstring_view fmt ) noexcept;
 (2) (since C++26)

Returns an object that stores a runtime format string directly usable in user-oriented formatting functions and can be implicitly converted to std::basic_format_string.

1,2) Equivalent to return fmt;.

Contents

Parameters

fmt -
[edit]
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.

Return value

An object holding the runtime format string of the exposition-only type:

Class template runtime-format-string <CharT>

template< class CharT >
struct /*runtime-format-string*/;
 (exposition only*)

Member objects

The returned object contains an exposition-only non-static data member str of type std::basic_string_view<CharT>.

Constructors and assignments

/*runtime-format-string*/( std::basic_string_view<CharT> s ) noexcept;
 (1)
/*runtime-format-string*/( const /*runtime-format-string*/& ) = delete;
 (2)
/*runtime-format-string*/& operator=( const /*runtime-format-string*/& ) = delete;
 (3)
1) Initializes str with s.
2) Copy constructor is explicitly deleted. The type is neither copyable nor movable.
3) The assignment is explicitly deleted.

Notes

Since the return type of std::runtime_format is neither copyable nor movable, an attempt of passing runtime_fmt as glvalue inhibits the construction of std::format_string which results in program ill-formed. To construct std::format_string with std::runtime_format, the returned value of std::runtime_format is passed directly on std::format_string as prvalue where copy elision is guaranteed. 

auto runtime_fmt = std::runtime_format("{}");
 
auto s0 = std::format(runtime_fmt, 1); // error
auto s1 = std::format(std::move(runtime_fmt), 1); // still error
auto s2 = std::format(std::runtime_format("{}"), 1); // ok
Feature-test macro Value Std Feature
__cpp_lib_format 202311L (C++26) Runtime format strings


Example

Run this code
#include <format>
#include <print>
#include <string>
#include <string_view>
 
int main()
{
    std::print("Hello {}!\n", "world");
 
    std::string fmt;
    for (int i{}; i != 3; ++i)
    {
        fmt += "{} "; // constructs the formatting string
        std::print("{} : ", fmt);
        std::println(std::runtime_format(fmt), "alpha", 'Z', 3.14, "unused");
    }
}

Output: 

Hello world!
{}  : alpha
{} {}  : alpha Z
{} {} {}  : alpha Z 3.14

See also

(C++20)
 stores formatted representation of the arguments in a new string
(function template) [edit]
(C++20)
 non-template variant of std::format using type-erased argument representation
(function) [edit]
(C++20)(C++20)(C++20)
 class template that performs compile-time format string checks at construction time
(class template) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/utility/format/runtime_format&oldid=166334"