fmtlib/fmt
1
0
Fork 1
mirror of https://github.com/fmtlib/fmt.git synced 2025-07-30 10:47:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Victor Zverovich
2019-03-16 07:59:58 -07:00
parent 0fa65cf329
commit 9b392a683d
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.rst
View File

@ -61,14 +61,15 @@ Print ``Hello, world!`` to ``stdout``:
.. code:: c++ .. code:: c++
fmt::print("Hello, {}!", "world"); // uses Python-like format string syntax fmt::print("Hello, {}!", "world"); // Python-like format string syntax
fmt::printf("Hello, %s!", "world"); // uses printf format string syntax fmt::printf("Hello, %s!", "world"); // printf format string syntax
Format a string and use positional arguments: Format a string and use positional arguments:
.. code:: c++ .. code:: c++
std::string s = fmt::format("I'd rather be {1} than {0}.", "right", "happy"); std::string s = fmt::format("I'd rather be {1} than {0}.", "right", "happy");
// s == "I'd rather be happy than right."
Check a format string at compile time: Check a format string at compile time:
@ -101,7 +102,7 @@ Use {fmt} as a safe portable replacement for ``itoa``
fmt::memory_buffer buf; fmt::memory_buffer buf;
format_to(buf, "{}", 42); // replaces itoa(42, buffer, 10) format_to(buf, "{}", 42); // replaces itoa(42, buffer, 10)
format_to(buf, "{:x}", 42); // replaces itoa(42, buffer, 16) format_to(buf, "{:x}", 42); // replaces itoa(42, buffer, 16)
// access the string using to_string(buf) or buf.data() // access the string with to_string(buf) or buf.data()
Formatting of user-defined types is supported via a simple Formatting of user-defined types is supported via a simple
`extension API <http://fmtlib.net/latest/api.html#formatting-user-defined-types>`_: `extension API <http://fmtlib.net/latest/api.html#formatting-user-defined-types>`_:
@ -148,7 +149,7 @@ which take arbitrary arguments (`godbolt <https://godbolt.org/g/MHjHVf>`_):
report_error("file not found: {}", path); report_error("file not found: {}", path);
Note that ``vreport_error`` is not parameterized on argument types which can Note that ``vreport_error`` is not parameterized on argument types which can
improve compile times and reduce code size compared to fully parameterized improve compile times and reduce code size compared to a fully parameterized
version. version.
Benchmarks Benchmarks