fmtlib/fmt
1
0
Fork 1
mirror of https://github.com/fmtlib/fmt.git synced 2025-09-25 14:10:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Victor Zverovich
2025-09-01 10:15:54 -07:00
parent 8ba99c0f05
commit 20e0d6d8dd
2 changed files with 24 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api.md
View File

@@ -558,7 +558,7 @@ marked with `FMT_COMPILE` or `_cf` are parsed, checked and converted into
efficient formatting code at compile-time. This supports arguments of built-in efficient formatting code at compile-time. This supports arguments of built-in
and string types as well as user-defined types with `format` methods taking and string types as well as user-defined types with `format` methods taking
the format context type as a template parameter in their `formatter` the format context type as a template parameter in their `formatter`
specializations. For example: specializations. For example ([run](https://www.godbolt.org/z/3c13erEoq)):
struct point { struct point {
double x; double x;
@@ -586,7 +586,7 @@ and `consteval` functions. Additionally there is an experimental
`FMT_STATIC_FORMAT` that allows formatting into a string of the exact `FMT_STATIC_FORMAT` that allows formatting into a string of the exact
required size at compile time. Compile-time formatting works with built-in required size at compile time. Compile-time formatting works with built-in
and user-defined formatters that have `constexpr` `format` methods. and user-defined formatters that have `constexpr` `format` methods.
Example ([run](https://www.godbolt.org/z/3c13erEoq)): Example:
template <> struct fmt::formatter<point> { template <> struct fmt::formatter<point> {
constexpr auto parse(format_parse_context& ctx) { return ctx.begin(); } constexpr auto parse(format_parse_context& ctx) { return ctx.begin(); }

32
include/fmt/compile.h
View File

@@ -22,8 +22,6 @@ FMT_EXPORT class compiled_string {};
template <typename S> template <typename S>
struct is_compiled_string : std::is_base_of<compiled_string, S> {}; struct is_compiled_string : std::is_base_of<compiled_string, S> {};
namespace detail {
/** /**
* Converts a string literal `s` into a format string that will be parsed at * Converts a string literal `s` into a format string that will be parsed at
* compile time and converted into efficient formatting code. Requires C++17 * compile time and converted into efficient formatting code. Requires C++17
@@ -41,6 +39,28 @@ namespace detail {
# define FMT_COMPILE(s) FMT_STRING(s) # define FMT_COMPILE(s) FMT_STRING(s)
#endif #endif
/**
* Converts a string literal into a format string that will be parsed at
* compile time and converted into efficient formatting code. Requires support
* for class types in constant template parameters (a C++20 feature).
*
* **Example**:
*
* // Converts 42 into std::string using the most efficient method and no
* // runtime format string processing.
* using namespace fmt::literals;
* std::string s = fmt::format("{}"_cf, 42);
*/
#if FMT_USE_NONTYPE_TEMPLATE_ARGS
inline namespace literals {
template <detail::fixed_string Str> constexpr auto operator""_cf() {
return FMT_COMPILE(Str.data);
}
} // namespace literals
#endif
namespace detail {
template <typename T, typename... Tail> template <typename T, typename... Tail>
constexpr auto first(const T& value, const Tail&...) -> const T& { constexpr auto first(const T& value, const Tail&...) -> const T& {
return value; return value;
@@ -559,14 +579,6 @@ template <size_t N> class static_format_result {
fmt::formatted_size(FMT_COMPILE(fmt_str), __VA_ARGS__) + 1>( \ fmt::formatted_size(FMT_COMPILE(fmt_str), __VA_ARGS__) + 1>( \
FMT_COMPILE(fmt_str), __VA_ARGS__) FMT_COMPILE(fmt_str), __VA_ARGS__)
#if FMT_USE_NONTYPE_TEMPLATE_ARGS
inline namespace literals {
template <detail::fixed_string Str> constexpr auto operator""_cf() {
return FMT_COMPILE(Str.data);
}
} // namespace literals
#endif
FMT_END_EXPORT FMT_END_EXPORT
FMT_END_NAMESPACE FMT_END_NAMESPACE