mirror/fmt
1
0
Fork 0
mirror of https://github.com/fmtlib/fmt.git synced 2024-12-25 06:21:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use syntax highlighting for all examples.

Browse Source
This commit is contained in:
Victor Zverovich 2012-12-13 08:12:09 -08:00
parent 9dc5e3f0c2
commit a8a536bde5
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.rst
View File

@ -1,8 +1,6 @@
format format
====== ======
.. highlight:: c++
Format is an open-source C++ library that provides Format is an open-source C++ library that provides
string formatting functionality similar to `str.format string formatting functionality similar to `str.format
<http://docs.python.org/2/library/stdtypes.html#str.format>`__ <http://docs.python.org/2/library/stdtypes.html#str.format>`__
@ -29,19 +27,23 @@ Features
Examples Examples
-------- --------
This prints "Hello, world!" to stdout: This prints ``Hello, world!`` to stdout:
.. code-block:: c++ .. code-block:: c++
fmt::Print("Hello, {0}!") << "world"; fmt::Print("Hello, {0}!") << "world";
Arguments are accessed by position and arguments' indices can be repeated:: Arguments are accessed by position and arguments' indices can be repeated:
.. code-block:: c++
std::string s = str(fmt::Format("{0}{1}{0}") << "abra" << "cad"); std::string s = str(fmt::Format("{0}{1}{0}") << "abra" << "cad");
// s == "abracadabra" // s == "abracadabra"
An object of any user-defined type for which there is an overloaded An object of any user-defined type for which there is an overloaded
``std::ostream`` insertion operator (``operator<<``) can be formatted:: ``std::ostream`` insertion operator (``operator<<``) can be formatted:
.. code-block:: c++
class Date { class Date {
int year_, month_, day_; int year_, month_, day_;
@ -59,7 +61,9 @@ An object of any user-defined type for which there is an overloaded
You can use ``fmt::ActiveFormatter`` to create your own functions You can use ``fmt::ActiveFormatter`` to create your own functions
similar to ``fmt::Format`` and ``fmt::Print`` with an arbitrary action similar to ``fmt::Format`` and ``fmt::Print`` with an arbitrary action
performed when formatting is complete:: performed when formatting is complete:
.. code-block:: c++
struct PrintError { struct PrintError {
void operator()(const fmt::Formatter &f) const { void operator()(const fmt::Formatter &f) const {
@ -125,11 +129,15 @@ platforms.
IOStreams IOStreams
~~~~~~~~~ ~~~~~~~~~
The main issue with IOStreams is best illustrated with an example:: The main issue with IOStreams is best illustrated with an example:
.. code-block:: c++
std::cout << std::setprecision(2) << std::fixed << 1.23456 << "\n"; std::cout << std::setprecision(2) << std::fixed << 1.23456 << "\n";
which is a lot of typing compared to printf:: which is a lot of typing compared to printf:
.. code-block:: c++
printf("%.2f\n", 1.23456); printf("%.2f\n", 1.23456);