You are viewing the develop version of this library.
The master and develop pages are shown here to provide access to the newest in-development in-progress documentation. See the "Documentation" link on this page.
Other aspects of the page will reflect the previous official version, or not be available until the next release.
Format, part of the collection of Boost C++ Libraries, provides a type-safe mechanism for formatting arguments according to a printf-like format-string. User-defined types are supported by providing a std::ostream operator << implementation for them.
Distributed under the Boost Software License, Version 1.0.
| Branch | GHA CI | Appveyor | Coverity Scan | codecov.io | Deps | Docs | Tests |
|---|---|---|---|---|---|---|---|
master |
|||||||
develop |
| Name | Purpose |
|---|---|
benchmark |
benchmark tool |
doc |
documentation |
examples |
use case examples |
include |
headers |
test |
unit tests |
tools |
development tools |
[format] tag at the beginning of the subject line.<p>Format, part of the collection of <a href="https://github.com/boostorg">Boost C++ Libraries</a>, provides a type-safe mechanism for formatting arguments according to a printf-like format-string. User-defined types are supported by providing a <code>std::ostream operator <<</code> implementation for them.</p> <h3>License</h3> <p>Distributed under the <a href="https://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p> <h3>Properties</h3> <ul> <li>C++11</li> <li>Header-only</li> </ul> <h3>Build Status</h3> <!-- boost-ci/tools/makebadges.sh --project format --appveyor aeg8obnkb0mrgqvd --codecov --coverity 14007 --> <table> <thead> <tr> <th align="center">Branch</th> <th align="left">GHA CI</th> <th align="left">Appveyor</th> <th align="left">Coverity Scan</th> <th align="left">codecov.io</th> <th align="left">Deps</th> <th align="left">Docs</th> <th align="left">Tests</th> </tr> </thead> <tbody> <tr> <td align="center"><a href="https://github.com/boostorg/format/tree/master"><code>master</code></a></td> <td align="left"><a href="https://github.com/boostorg/format/actions?query=branch:master"><img src="https://github.com/boostorg/format/actions/workflows/ci.yml/badge.svg?branch=master" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/cppalliance/format/branch/master"><img src="https://ci.appveyor.com/api/projects/status/aeg8obnkb0mrgqvd/branch/master?svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://scan.coverity.com/projects/boostorg-format"><img src="https://scan.coverity.com/projects/14007/badge.svg" alt="Coverity Scan Build Status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/format/tree/master"><img src="https://codecov.io/gh/boostorg/format/branch/master/graph/badge.svg?token=" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/master/format.html"><img src="https://img.shields.io/badge/deps-master-brightgreen.svg" alt="Deps" /></a></td> <td align="left"><a href="https://www.boost.org/doc/libs/master/libs/format"><img src="https://img.shields.io/badge/docs-master-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="https://www.boost.org/development/tests/master/developer/format.html"><img src="https://img.shields.io/badge/matrix-master-brightgreen.svg" alt="Enter the Matrix" /></a></td> </tr> <tr> <td align="center"><a href="https://github.com/boostorg/format/tree/develop"><code>develop</code></a></td> <td align="left"><a href="https://github.com/boostorg/format/actions?query=branch:develop"><img src="https://github.com/boostorg/format/actions/workflows/ci.yml/badge.svg?branch=develop" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/cppalliance/format/branch/develop"><img src="https://ci.appveyor.com/api/projects/status/aeg8obnkb0mrgqvd/branch/develop?svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://scan.coverity.com/projects/boostorg-format"><img src="https://scan.coverity.com/projects/14007/badge.svg" alt="Coverity Scan Build Status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/format/tree/develop"><img src="https://codecov.io/gh/boostorg/format/branch/develop/graph/badge.svg?token=" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/develop/format.html"><img src="https://img.shields.io/badge/deps-develop-brightgreen.svg" alt="Deps" /></a></td> <td align="left"><a href="https://www.boost.org/doc/libs/develop/libs/format"><img src="https://img.shields.io/badge/docs-develop-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="https://www.boost.org/development/tests/develop/developer/format.html"><img src="https://img.shields.io/badge/matrix-develop-brightgreen.svg" alt="Enter the Matrix" /></a></td> </tr> </tbody> </table> <h3>Directories</h3> <table> <thead> <tr> <th align="left">Name</th> <th align="left">Purpose</th> </tr> </thead> <tbody> <tr> <td align="left"><code>benchmark</code></td> <td align="left">benchmark tool</td> </tr> <tr> <td align="left"><code>doc</code></td> <td align="left">documentation</td> </tr> <tr> <td align="left"><code>examples</code></td> <td align="left">use case examples</td> </tr> <tr> <td align="left"><code>include</code></td> <td align="left">headers</td> </tr> <tr> <td align="left"><code>test</code></td> <td align="left">unit tests</td> </tr> <tr> <td align="left"><code>tools</code></td> <td align="left">development tools</td> </tr> </tbody> </table> <h3>More information</h3> <ul> <li><a href="https://stackoverflow.com/questions/ask?tags=c%2B%2B,boost,boost-format">Ask questions</a>: Be sure to read the documentation first as Boost.Format, like any other string formatting library, has its own rules.</li> <li><a href="https://github.com/boostorg/format/issues">Report bugs</a>: Be sure to mention Boost version, platform and compiler you're using. A small compilable code sample to reproduce the problem is always good as well.</li> <li><a href="https://github.com/boostorg/format/pulls">Submit Pull Requests</a> against the <strong>develop</strong> branch. Note that by submitting patches you agree to license your modifications under the <a href="https://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>. Be sure to include tests proving your changes work properly.</li> <li>Discussions about the library are held on the <a href="https://www.boost.org/community/groups.html#main">Boost developers mailing list</a>. Be sure to read the <a href="https://www.boost.org/community/policy.html">discussion policy</a> before posting and add the <code>[format]</code> tag at the beginning of the subject line.</li> </ul>
<p>Format, part of the collection of <a href="https://github.com/boostorg">Boost C++ Libraries</a>, provides a type-safe mechanism for formatting arguments according to a printf-like format-string. User-defined types are supported by providing a <code>std::ostream operator <<</code> implementation for them.</p> <h3>License</h3> <p>Distributed under the <a href="https://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p> <h3>Properties</h3> <ul> <li>C++11</li> <li>Header-only</li> </ul> <h3>Build Status</h3> <!-- boost-ci/tools/makebadges.sh --project format --appveyor aeg8obnkb0mrgqvd --codecov --coverity 14007 --> <table> <thead> <tr> <th align="center">Branch</th> <th align="left">GHA CI</th> <th align="left">Appveyor</th> <th align="left">Coverity Scan</th> <th align="left">codecov.io</th> <th align="left">Deps</th> <th align="left">Docs</th> <th align="left">Tests</th> </tr> </thead> <tbody> <tr> <td align="center"><a href="https://github.com/boostorg/format/tree/master"><code>master</code></a></td> <td align="left"><a href="https://github.com/boostorg/format/actions?query=branch:master"><img src="https://github.com/boostorg/format/actions/workflows/ci.yml/badge.svg?branch=master" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/cppalliance/format/branch/master"><img src="https://ci.appveyor.com/api/projects/status/aeg8obnkb0mrgqvd/branch/master?svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://scan.coverity.com/projects/boostorg-format"><img src="https://scan.coverity.com/projects/14007/badge.svg" alt="Coverity Scan Build Status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/format/tree/master"><img src="https://codecov.io/gh/boostorg/format/branch/master/graph/badge.svg?token=" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/master/format.html"><img src="https://img.shields.io/badge/deps-master-brightgreen.svg" alt="Deps" /></a></td> <td align="left"><a href="https://www.boost.org/doc/libs/master/libs/format"><img src="https://img.shields.io/badge/docs-master-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="https://www.boost.org/development/tests/master/developer/format.html"><img src="https://img.shields.io/badge/matrix-master-brightgreen.svg" alt="Enter the Matrix" /></a></td> </tr> <tr> <td align="center"><a href="https://github.com/boostorg/format/tree/develop"><code>develop</code></a></td> <td align="left"><a href="https://github.com/boostorg/format/actions?query=branch:develop"><img src="https://github.com/boostorg/format/actions/workflows/ci.yml/badge.svg?branch=develop" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/cppalliance/format/branch/develop"><img src="https://ci.appveyor.com/api/projects/status/aeg8obnkb0mrgqvd/branch/develop?svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://scan.coverity.com/projects/boostorg-format"><img src="https://scan.coverity.com/projects/14007/badge.svg" alt="Coverity Scan Build Status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/format/tree/develop"><img src="https://codecov.io/gh/boostorg/format/branch/develop/graph/badge.svg?token=" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/develop/format.html"><img src="https://img.shields.io/badge/deps-develop-brightgreen.svg" alt="Deps" /></a></td> <td align="left"><a href="https://www.boost.org/doc/libs/develop/libs/format"><img src="https://img.shields.io/badge/docs-develop-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="https://www.boost.org/development/tests/develop/developer/format.html"><img src="https://img.shields.io/badge/matrix-develop-brightgreen.svg" alt="Enter the Matrix" /></a></td> </tr> </tbody> </table> <h3>Directories</h3> <table> <thead> <tr> <th align="left">Name</th> <th align="left">Purpose</th> </tr> </thead> <tbody> <tr> <td align="left"><code>benchmark</code></td> <td align="left">benchmark tool</td> </tr> <tr> <td align="left"><code>doc</code></td> <td align="left">documentation</td> </tr> <tr> <td align="left"><code>examples</code></td> <td align="left">use case examples</td> </tr> <tr> <td align="left"><code>include</code></td> <td align="left">headers</td> </tr> <tr> <td align="left"><code>test</code></td> <td align="left">unit tests</td> </tr> <tr> <td align="left"><code>tools</code></td> <td align="left">development tools</td> </tr> </tbody> </table> <h3>More information</h3> <ul> <li><a href="https://stackoverflow.com/questions/ask?tags=c%2B%2B,boost,boost-format">Ask questions</a>: Be sure to read the documentation first as Boost.Format, like any other string formatting library, has its own rules.</li> <li><a href="https://github.com/boostorg/format/issues">Report bugs</a>: Be sure to mention Boost version, platform and compiler you're using. A small compilable code sample to reproduce the problem is always good as well.</li> <li><a href="https://github.com/boostorg/format/pulls">Submit Pull Requests</a> against the <strong>develop</strong> branch. Note that by submitting patches you agree to license your modifications under the <a href="https://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>. Be sure to include tests proving your changes work properly.</li> <li>Discussions about the library are held on the <a href="https://www.boost.org/community/groups.html#main">Boost developers mailing list</a>. Be sure to read the <a href="https://www.boost.org/community/policy.html">discussion policy</a> before posting and add the <code>[format]</code> tag at the beginning of the subject line.</li> </ul>