gzip_block_ostream.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_IO_GZIP_BLOCK_OSTREAM_H_
#define GENESIS_UTILS_IO_GZIP_BLOCK_OSTREAM_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2024 Lucas Czech
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lucas.czech@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/
 
#include "genesis/utils/io/gzip.hpp"
#include "genesis/utils/io/gzip_stream.hpp"
#include "genesis/utils/threading/thread_pool.hpp"
 
#include <memory>
#include <sstream>
#include <string>
 
namespace genesis {
namespace utils {
 
// ================================================================================================
//     Gzip Block Output Stream
// ================================================================================================
 
class GzipBlockOStream
    : public std::ostream
{
public:
 
    explicit GzipBlockOStream(
        std::ostream& os,
        std::size_t block_size = GZIP_DEFAULT_BLOCK_SIZE,
        GzipCompressionLevel compression_level = GzipCompressionLevel::kDefaultCompression,
        std::shared_ptr<ThreadPool> thread_pool = nullptr
    );
 
    explicit GzipBlockOStream(
        std::streambuf* sbuf_p,
        std::size_t block_size = GZIP_DEFAULT_BLOCK_SIZE,
        GzipCompressionLevel compression_level = GzipCompressionLevel::kDefaultCompression,
        std::shared_ptr<ThreadPool> thread_pool = nullptr
    );
 
    virtual ~GzipBlockOStream();
 
    static const std::size_t GZIP_DEFAULT_BLOCK_SIZE = 1ul << 16;
};
 
} // namespace utils
} // namespace genesis
 
#endif // include guard