diff options
author | Jack Lloyd <[email protected]> | 2018-05-22 08:57:43 -0400 |
---|---|---|
committer | Jack Lloyd <[email protected]> | 2018-05-22 08:57:43 -0400 |
commit | 8c84e39d31ab3147ce35969a23ea03f6ef841986 (patch) | |
tree | 88d9cc0b2996e117480e261f6cbcd08635d0e145 /doc/manual | |
parent | cd0bcd90817ece3e4fcba32e06a372580bbe3008 (diff) |
Correct outdated material in filter doc [ci skip]
Diffstat (limited to 'doc/manual')
-rw-r--r-- | doc/manual/filters.rst | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/doc/manual/filters.rst b/doc/manual/filters.rst index cae50cc33..f62d78ce2 100644 --- a/doc/manual/filters.rst +++ b/doc/manual/filters.rst @@ -85,16 +85,13 @@ generator. If you want to, you can explicitly set up the random number generators and entropy sources you want to, however for 99% of cases ``AutoSeeded_RNG`` is preferable. -``Pipe`` also has convenience methods for dealing with -``std::iostream``. Here is an example of those, using the -``Bzip_Compression`` filter (included as a module; if you have bzlib -available, check the build instructions for how to enable it) to -compress a file:: +``Pipe`` also has convenience methods for dealing with ``std::iostream``. +Here is an example of this, using the bzip2 compression filter:: std::ifstream in("data.bin", std::ios::binary) std::ofstream out("data.bin.bz2", std::ios::binary) - Pipe pipe(new Bzip_Compression); + Pipe pipe(new Compression_Filter("bzip2", 9)); pipe.start_msg(); in >> pipe; @@ -113,7 +110,7 @@ reading it out later, we divert it directly to the file:: std::ifstream in("data.bin", std::ios::binary) std::ofstream out("data.bin.bz2", std::ios::binary) - Pipe pipe(new Bzip_Compression, new DataSink_Stream(out)); + Pipe pipe(new Compression_Filter("bzip2", 9), new DataSink_Stream(out)); pipe.start_msg(); in >> pipe; |