pyzim.compression.ZlibDecompressorWrapper

class documentation

class ZlibDecompressorWrapper(object):

A wrapper around zlib.decompressobj to provide additional attributes.

Method	`__init__`	The default constructor.
Method	`decompress`	Return a bytes object containing the decompressed version of the data.
Property	`eof`	True if the end of the data stream has been reached.
Property	`needs_input`	True if additional input is needed before more data can be decompressed.
Property	`unused_data`	Data found after the end of the compressed stream.
Instance Variable	`_buffer`	Undocumented
Instance Variable	`_decompressor`	Undocumented

def __init__(self, wbits=None, zdict=None): ¶

The default constructor.

Parameters
wbits:`int` or `None`	window size to use
zdict:`bytes` or `None`	compression dictionary to use (must be the same as used by the compressor)

def decompress(self, data, max_length=-1): ¶

Return a bytes object containing the decompressed version of the data.

Parameters
data:`bytes`	binary data to decompress
max_length:`int`	The maximum allowable length of the decompressed data.

eof: bool = ¶

True if the end of the data stream has been reached.

needs_input: bool = ¶

True if additional input is needed before more data can be decompressed.

unused_data: bytes = ¶

Data found after the end of the compressed stream.

_buffer: bytes = ¶

Undocumented

_decompressor = ¶

Undocumented