Class BitStreamCompressor

Synopsis

#include <include/bitstreamcompressor.hpp>

class BitStreamCompressor : public BitArchiveCreator

Description

No description yet.

Mentioned in

Inheritance

Ancestors: BitArchiveCreator

Methods

BitStreamCompressorConstructs a BitStreamCompressor object.
compress OverloadCompresses the given standard istream to the standard ostream.
compress OverloadCompresses the given standard istream to the output buffer.
compress OverloadCompresses the given standard istream to an archive on the filesystem.

Source

Lines 11-51 in include/bitstreamcompressor.hpp.

class BitStreamCompressor : public BitArchiveCreator {
    public:
        /**
         * @brief Constructs a BitStreamCompressor object.
         *
         * The Bit7zLibrary parameter is needed in order to have access to the functionalities
         * of the 7z DLLs. On the other hand, the BitInOutFormat is required in order to know the
         * format of the input archive.
         *
         * @param lib       the 7z library used.
         * @param format    the input archive format.
         */
        BitStreamCompressor( const Bit7zLibrary& lib, const BitInOutFormat& format );
        /**
         * @brief Compresses the given standard istream to the standard ostream.
         *
         * @param in_stream         the (binary) stream to be compressed.
         * @param out_stream        the (binary) stream where the archive will be output.
         * @param in_stream_name    (optional) the name to be used for the content of the archive.
         */
        void compress( istream& in_stream, ostream& out_stream, const wstring& in_stream_name = L"" ) const;
        /**
         * @brief Compresses the given standard istream to the output buffer.
         *
         * @param in_stream         the (binary) stream to be compressed.
         * @param out_buffer        the buffer going to contain the output archive.
         * @param in_stream_name    (optional) the name to be used for the content of the archive.
         */
        void compress( istream& in_stream, vector< byte_t >& out_buffer, const wstring& in_stream_name = L"" ) const;
        /**
         * @brief Compresses the given standard istream to an archive on the filesystem.
         *
         * @param in_stream         the (binary) stream to be compressed.
         * @param out_file          the output archive file path.
         * @param in_stream_name    (optional) the name to be used for the content of the archive.
         */
        void compress( istream& in_stream, const wstring& out_file, const wstring& in_stream_name = L"" ) const;
};





Add Discussion as Guest

Log in