Compress::Raw::Bzip2 provides an interface to the in-memory compression/uncompression functions from the bzip2 compression library.

Although the primary purpose for the existence of Compress::Raw::Bzip2 is for use by the IO::Compress::Bzip2 and IO::Compress::Bunzip2 modules, it can be used on its own for simple compression/uncompression tasks.

blockSize100k specifies the block size to be used for compression. It
should be a value between 1 and 9 inclusive, and the actual block size
used is 100000 x this figure. 9 gives the best compression but takes
most memory.

This parameter controls how the compression phase behaves when
presented with worst case, highly repetitive, input data. If
compression runs into difficulties caused by repetitive data, the
library switches from the standard sorting algorithm to a fallback
algorithm. The fallback is slower than the standard algorithm by
perhaps a factor of three, but always behaves reasonably, no matter how
bad the input.
Lower values of workFactor reduce the amount of effort the standard
algorithm will expend before resorting to the fallback. You should set
this parameter carefully; too low, and many inputs will be handled by
the fallback algorithm and so compress rather slowly, too high, and
your average-to-worst case compression times can become very large. The
default value of 30 gives reasonable behaviour over a wide range of
circumstances.
Allowable values range from 0 to 250 inclusive. 0 is a special case,
equivalent to using the default value of 30.

Reads the contents of $input, compresses it and writes the compressed data to $output.

Returns BZ_RUN_OK on success and a bzip2 error code on failure.

If appendOutput is enabled in the constructor for the bzip2 object, the compressed data will be appended to $output. If not enabled, $output will be truncated before the compressed data is written to it.

If small is nonzero, the library will use an alternative decompression
algorithm which uses less memory but at the cost of decompressing more
slowly (roughly speaking, half the speed, but the maximum memory
requirement drops to around 2300k).

The LimitOutput option changes the behavior of the $i->bzinflate method so that the amount of memory used by the output buffer can be limited.

When LimitOutput is used the size of the output buffer used will either be the 16k or the amount of memory already allocated to $output, whichever is larger. Predicting the output size available is tricky, so don't rely on getting an exact output buffer size.

When LimitOutout is not specified $i->bzinflate will use as much memory as it takes to write all the uncompressed data it creates by uncompressing the input buffer.

If LimitOutput is enabled, the ConsumeInput option will also be enabled.

Returns BZ_OK if the uncompression was successful, but the end of the compressed data stream has not been reached. Returns BZ_STREAM_END on successful uncompression and the end of the compression stream has been reached.

If consumeInput is enabled in the constructor for the bunzip2 object, $input will have all compressed data removed from it after uncompression. On BZ_OK return this will mean that $input will be an empty string; when BZ_STREAM_END$input will either be an empty string or will contain whatever data immediately followed the compressed data stream.

If appendOutput is enabled in the constructor for the bunzip2 object, the uncompressed data will be appended to $output. If not enabled, $output will be truncated before the uncompressed data is written to it.