pyzim.compression.ZstandardCompressionInterface

class documentation

class ZstandardCompressionInterface(BaseCompressionInterface):

View In Hierarchy

A pyzim.compression.BaseCompressionInterface for zstd compression using zstandard.

The following options are supported:

  • zstd.option: a zstd level (int) or advanced compression parameters (dict)
  • zstd.dict: pre-trained dictionary for compression (type zstd.ZstdCompressionDict)
  • zstd.max_window_size: max window size for decompreession operations
  • zstd.buffer_size: size of the output buffer
Static Method get_compressor Return a compressor object which can be used to compress data.
Static Method get_decompressor Return a decompressor object which can be used to decompress data.

Inherited from BaseCompressionInterface:

Class Variable compression_type compression type used by this interface
def get_compressor(options={}):
overrides pyzim.compression.BaseCompressionInterface.get_compressor

Return a compressor object which can be used to compress data.

Parameters
options:dictadditional options for the compressor.
Returns
a compressor-like object. See pyzim.compression.BaseCompressionInterface for more info.a compressor object
def get_decompressor(options={}):
overrides pyzim.compression.BaseCompressionInterface.get_decompressor

Return a decompressor object which can be used to decompress data.

Parameters
options:dictadditional options for the decompressor.
Returns
a decompressor-like object. See pyzim.compression.BaseCompressionInterface for more info.a decompressor object