{fmt}

{fmt} is an open-source formatting library providing a fast and safe alternative to C stdio and C++ iostreams.

If you like this project, please consider donating to BY_Help, an initiative to help victims of political repressions in Belarus: Documentation

Q&A: ask questions on Compiler Explorer.

Features

• Simple C++20 std::format
• format
• Fast IEEE 754 floating-point formatter with correct rounding, shortness and round-trip guarantees
• Safe support for user-defined types
• High performance: faster than common standard library implementations of (s)printf, iostreams, to_string and to_chars, see Speed tests and Compile time and code bloat
• Reliability: the library has an extensive set of continuously fuzzed
• Safety: the library is fully type safe, errors in format strings can be reported at compile time, automatic memory management prevents buffer overflow errors
• Ease of use: small self-contained code base, no external dependencies, permissive MIT Portability with consistent output across platforms and support for older compilers
• Clean warning-free codebase even on high warning levels such as -Wall -Wextra -pedantic
• Locale-independence by default
• Optional header-only configuration enabled with the FMT_HEADER_ONLY macro

See the Examples

Print to stdout ( #include <fmt/core.h> int main() { fmt::print("Hello, world!\n"); }

Format a string ( std::string s = fmt::format("The answer is {}.", 42); // s == "The answer is 42."

Format a string using positional arguments ( std::string s = fmt::format("I'd rather be {1} than {0}.", "right", "happy"); // s == "I'd rather be happy than right."

Print chrono durations ( #include <fmt/chrono.h> int main() { using namespace std::literals::chrono_literals; fmt::print("Default format: {} {}\n", 42s, 100ms); fmt::print("strftime-like format: {:%H:%M:%S}\n", 3h + 15min + 30s); }

Output:

Default format: 42s 100ms
strftime-like format: 03:15:30

Print a container ( #include <vector> #include <fmt/ranges.h> int main() { std::vector<int> v = {1, 2, 3}; fmt::print("{}\n", v); }

Output:

{1, 2, 3}

std::string s = fmt::format(FMT_STRING("{:d}"), "I am not a number");

#include <fmt/os.h>

int main() {
 auto out = fmt::output_file("guide.txt");
 out.print("Don't {}", "Panic");
}

This can be #include <fmt/color.h> int main() { fmt::print(fg(fmt::color::crimson) | fmt::emphasis::bold, "Hello, {}!\n", "world"); fmt::print(fg(fmt::color::floral_white) | bg(fmt::color::slate_gray) | fmt::emphasis::underline, "Hello, {}!\n", "мир"); fmt::print(fg(fmt::color::steel_blue) | fmt::emphasis::italic, "Hello, {}!\n", "世界"); }

Output on a modern terminal:

Benchmarks

Speed tests

{fmt} is the fastest of the benchmarked methods, ~35% faster than printf.

The above results were generated by building tinyformat_test.cpp on macOS 10.14.6 with clang++ -O3 -DNDEBUG -DSPEED_TEST -DHAVE_FORMAT, and taking the best of three runs. In the test, the format string "%0.10f:%04d:%+g:%s:%p:%c:%%\n" or equivalent is filled 2,000,000 times with output sent to /dev/null; for further details refer to the dtoa-benchmark) and faster than ryu:

The script format-benchmark tests compile time and code bloat for nontrivial projects. It generates 100 translation units and uses printf() or its alternative five times in each to simulate a medium sized project. The resulting executable size and compile time (Apple LLVM version 8.1.0 (clang-802.0.42), macOS Sierra, best of three) is shown in the following tables.

Optimized build (-O3)

As you can see, {fmt} has 60% less overhead in terms of resulting binary code size compared to iostreams and comes pretty close to printf. Boost Format and Folly Format have the largest overheads.

printf+string is the same as printf but with extra <string> include to measure the overhead of the latter.

Non-optimized build

libc, lib(std)c++ and libfmt are all linked as shared libraries to compare formatting function overhead only. Boost Format is a header-only library so it doesn't provide any linkage options.

Running the tests

Please refer to format-benchmarks, so to run the benchmarks you first need to clone this repository and generate Makefiles with CMake:

$ git clone --recursive https://github.com/fmtlib/format-benchmark.git
$ cd format-benchmark
$ cmake .

Then you can run the speed test:

$ make speed-test

or the bloat test:

$ make bloat-test

Projects using this library

• 2GIS: free business listings with a city map
• Aseprite: animated sprite editor & pixel art tool
• Blizzard Battle.net: an online gaming platform
• Ceph: a scalable distributed storage system
• ClickHouse: analytical database management system
• Drake: a planning, control, and analysis toolbox for nonlinear dynamical systems (MIT)
• FiveM: a modification framework for GTA V
• HarpyWar/pvpgn: Player vs Player Gaming Network with tweaks
• Keypirinha: a semantic launcher for Windows
• Knuth: high-performance Bitcoin full-node
• MongoDB: distributed document database
• OpenSpace: an open-source astrovisualization framework
• PyTorch: an open-source machine learning library
• Quill: asynchronous low-latency logging library
• redis-cerberus: a Redis cluster proxy
• rpclib: a modern C++ msgpack-RPC server and client library
• Scylla: a Cassandra-compatible NoSQL data store that can handle 1 million transactions per second on a single server
• spdlog: super fast C++ logging library
• Touch Surgery: surgery simulator
• Windows Terminal: the new Windows terminal

email or by submitting an Motivation

So why yet another formatting library?

There are plenty of methods for doing this task, from standard ones like the printf family of function and iostreams to Boost Format and FastFormat libraries. The reason for creating a new library is that every existing solution that I found either had serious issues or didn't provide all the features I needed.

printf

The good thing about printf is that it is pretty fast and readily available being a part of the C standard library. The main drawback is that it doesn't support user-defined types. printf also has safety issues although they are somewhat mitigated with i18n to printf but it is not a part of C99 and may not be available on some platforms.

iostreams

The main issue with iostreams is best illustrated with an example:

std::cout << std::setprecision(2) << std::fixed << 1.23456 << "\n";

which is a lot of typing compared to printf:

printf("%.2f\n", 1.23456);

Matthew Wilson, the author of FastFormat, called this "chevron hell". iostreams don't support positional arguments by design.

The good part is that iostreams support user-defined types and are safe although error handling is awkward.

Boost Format

This is a very powerful library which supports both printf-like format strings and positional arguments. Its main drawback is performance. According to various, benchmarks it is much slower than other methods considered here. Boost Format also has excessive build times and severe code bloat issues (see Benchmarks).

FastFormat

This is an interesting library which is fast, safe and has positional arguments. However, it has significant limitations, citing its author:

Three features that have no hope of being accommodated within the current design are:

• Leading zeros (or any other non-space padding)
• Octal/hexadecimal encoding
• Runtime width/alignment specification

It is also quite big and has a heavy dependency, STLSoft, which might be too restrictive for using it in some projects.

Boost Spirit.Karma

This is not really a formatting library but I decided to include it here for completeness. As iostreams, it suffers from the problem of mixing verbatim text with arguments. The library is pretty fast, but slower on integer formatting than fmt::format_to with format string compilation on Karma's own benchmark, see License

{fmt} is distributed under the MIT Documentation License

The string module documentation. For this reason the documentation is distributed under the Python Software Foundation license available in Maintainers

The {fmt} library is maintained by Victor Zverovich (foonathan) with contributions from many other people. See Releases for some of the names. Let us know if your contribution is not listed or mentioned incorrectly and we'll make it right.