About Boost.Iostreams
Please check out the library's documentation to learn more.
Quick Start
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.
Contributors: This Release
Iostreams, part of collection of the Boost C++ Libraries, provides:
- Tools to make it easy to create standard C++ streams and stream buffers for accessing new Sources and Sinks.
- A framework for defining filters and attaching them to standard streams and stream buffers.
- A collection of ready-to-use Filters, Sources and Sinks.
- Utilities to save and restore stream state.
License
Distributed under the Boost Software License, Version 1.0.
Properties
- C++03
- Requires a Link Library
Build Status
| Branch | Travis | Appveyor | Coverity Scan | codecov.io | Deps | Docs | Tests |
|---|---|---|---|---|---|---|---|
master |
 |
 |
 |
 |
 |
 |
|
develop |
 |
|
 |
 |
 |
 |
Directories
| Name | Purpose |
|---|---|
doc |
documentation |
example |
examples |
include |
headers |
test |
unit tests |
More information
- Ask questions
- Report bugs: 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.
- Submit your patches as pull requests against develop branch. Note that by submitting patches you agree to license your modifications under the Boost Software License, Version 1.0.
- Discussions about the library are held on the Boost developers mailing list. Be sure to read the discussion policy before posting and add the
[iostreams]tag at the beginning of the subject line.
All Contributors
<p>Iostreams, part of collection of the <a href="http://github.com/boostorg">Boost C++ Libraries</a>, provides:</p> <ul> <li>Tools to make it easy to create standard C++ streams and stream buffers for accessing new Sources and Sinks.</li> <li>A framework for defining filters and attaching them to standard streams and stream buffers.</li> <li>A collection of ready-to-use Filters, Sources and Sinks.</li> <li>Utilities to save and restore stream state.</li> </ul> <h3>License</h3> <p>Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p> <h3>Properties</h3> <ul> <li>C++03</li> <li>Requires a Link Library</li> </ul> <h3>Build Status</h3> <table> <thead> <tr> <th align="center">Branch</th> <th align="left">Travis</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/iostreams/tree/master"><code>master</code></a></td> <td align="left"><a href="https://travis-ci.org/boostorg/iostreams"><img src="https://travis-ci.org/boostorg/iostreams.svg?branch=master" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/eldiener/iostreams/branch/master"><img src="https://ci.appveyor.com/api/projects/status/github/boostorg/iostreams?branch=master&svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://scan.coverity.com/projects/boostorg-iostreams"><img src="https://scan.coverity.com/projects/16463/badge.svg" alt="Coverity Scan Build Status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/iostreams/branch/master"><img src="https://codecov.io/gh/boostorg/iostreams/branch/master/graph/badge.svg" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/master/iostreams.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/iostreams/doc/index.html"><img src="https://img.shields.io/badge/docs-master-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="http://www.boost.org/development/tests/master/developer/iostreams.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/iostreams/tree/develop"><code>develop</code></a></td> <td align="left"><a href="https://travis-ci.org/boostorg/iostreams"><img src="https://travis-ci.org/boostorg/iostreams.svg?branch=develop" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/eldiener/iostreams/branch/develop"><img src="https://ci.appveyor.com/api/projects/status/github/boostorg/iostreams?branch=develop&svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://scan.coverity.com/projects/boostorg-iostreams"><img src="https://scan.coverity.com/projects/16463/badge.svg" alt="Coverity Scan Build Status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/iostreams/branch/develop"><img src="https://codecov.io/gh/boostorg/iostreams/branch/develop/graph/badge.svg" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/develop/iostreams.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/iostreams/doc/index.html"><img src="https://img.shields.io/badge/docs-develop-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="http://www.boost.org/development/tests/develop/developer/iostreams.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>doc</code></td> <td align="left">documentation</td> </tr> <tr> <td align="left"><code>example</code></td> <td align="left">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> </tbody> </table> <h3>More information</h3> <ul> <li><a href="http://stackoverflow.com/questions/ask?tags=c%2B%2B,boost,boost-iostreams">Ask questions</a></li> <li><a href="https://github.com/boostorg/iostreams/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>Submit your patches as pull requests against <strong>develop</strong> branch. Note that by submitting patches you agree to license your modifications under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</li> <li>Discussions about the library are held on the <a href="http://www.boost.org/community/groups.html#main">Boost developers mailing list</a>. Be sure to read the <a href="http://www.boost.org/community/policy.html">discussion policy</a> before posting and add the <code>[iostreams]</code> tag at the beginning of the subject line.</li> </ul>
-
Code Commits Commits authored to any Boost repository. With 1 contribution, you will earn the bronze badge for Code Commits.
-
Documentation Doc contributions using standardised Boost tooling (Antora / BoostLook). With 1 contribution, you will earn the bronze badge for Documentation.
-
Library Authoring Authored an original Boost library accepted into the collection. With 1 contribution, you will earn the bronze badge for Library Authoring.
-
Library Maintenance Number of libraries actively maintained. With 1 contribution, you will earn the bronze badge for Library Maintenance.
-
Library Review Formal review submissions on Boost proposals. With 1 contribution, you will earn the bronze badge for Library Review.
-
Library Versioning Authored new versions / releases of Boost libraries. With 10 contributions, you will earn the bronze badge for Library Versioning.
-
Mailing List Participation Participation on the Boost developers mailing list. With 1 contribution, you will earn the bronze badge for Mailing List Participation.
-
News Posts Published Articles / news posts published on Boost.org. With 1 contribution, you will earn the bronze badge for News Posts Published.
<p>Iostreams, part of collection of the <a href="http://github.com/boostorg">Boost C++ Libraries</a>, provides:</p> <ul> <li>Tools to make it easy to create standard C++ streams and stream buffers for accessing new Sources and Sinks.</li> <li>A framework for defining filters and attaching them to standard streams and stream buffers.</li> <li>A collection of ready-to-use Filters, Sources and Sinks.</li> <li>Utilities to save and restore stream state.</li> </ul> <h3>License</h3> <p>Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p> <h3>Properties</h3> <ul> <li>C++03</li> <li>Requires a Link Library</li> </ul> <h3>Build Status</h3> <table> <thead> <tr> <th align="center">Branch</th> <th align="left">Travis</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/iostreams/tree/master"><code>master</code></a></td> <td align="left"><a href="https://travis-ci.org/boostorg/iostreams"><img src="https://travis-ci.org/boostorg/iostreams.svg?branch=master" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/eldiener/iostreams/branch/master"><img src="https://ci.appveyor.com/api/projects/status/github/boostorg/iostreams?branch=master&svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://scan.coverity.com/projects/boostorg-iostreams"><img src="https://scan.coverity.com/projects/16463/badge.svg" alt="Coverity Scan Build Status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/iostreams/branch/master"><img src="https://codecov.io/gh/boostorg/iostreams/branch/master/graph/badge.svg" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/master/iostreams.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/iostreams/doc/index.html"><img src="https://img.shields.io/badge/docs-master-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="http://www.boost.org/development/tests/master/developer/iostreams.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/iostreams/tree/develop"><code>develop</code></a></td> <td align="left"><a href="https://travis-ci.org/boostorg/iostreams"><img src="https://travis-ci.org/boostorg/iostreams.svg?branch=develop" alt="Build Status" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/eldiener/iostreams/branch/develop"><img src="https://ci.appveyor.com/api/projects/status/github/boostorg/iostreams?branch=develop&svg=true" alt="Build status" /></a></td> <td align="left"><a href="https://scan.coverity.com/projects/boostorg-iostreams"><img src="https://scan.coverity.com/projects/16463/badge.svg" alt="Coverity Scan Build Status" /></a></td> <td align="left"><a href="https://codecov.io/gh/boostorg/iostreams/branch/develop"><img src="https://codecov.io/gh/boostorg/iostreams/branch/develop/graph/badge.svg" alt="codecov" /></a></td> <td align="left"><a href="https://pdimov.github.io/boostdep-report/develop/iostreams.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/iostreams/doc/index.html"><img src="https://img.shields.io/badge/docs-develop-brightgreen.svg" alt="Documentation" /></a></td> <td align="left"><a href="http://www.boost.org/development/tests/develop/developer/iostreams.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>doc</code></td> <td align="left">documentation</td> </tr> <tr> <td align="left"><code>example</code></td> <td align="left">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> </tbody> </table> <h3>More information</h3> <ul> <li><a href="http://stackoverflow.com/questions/ask?tags=c%2B%2B,boost,boost-iostreams">Ask questions</a></li> <li><a href="https://github.com/boostorg/iostreams/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>Submit your patches as pull requests against <strong>develop</strong> branch. Note that by submitting patches you agree to license your modifications under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</li> <li>Discussions about the library are held on the <a href="http://www.boost.org/community/groups.html#main">Boost developers mailing list</a>. Be sure to read the <a href="http://www.boost.org/community/policy.html">discussion policy</a> before posting and add the <code>[iostreams]</code> tag at the beginning of the subject line.</li> </ul>
-
Achievement-based Reflects the depth of your contributions. Accumulate achievements to unlock five tiers; Bronze, Silver, Gold, Platinum and Diamond.
-
Tenure-based Awarded in recognition of your time on the platform. The longer you've been part of the Boost community, the higher the tier you unlock.
-
Boost day celebration A celebration of the day you joined Boost. Awarded annually to mark another year as part of the community.
