:py:mod:`dissect.util.compression.lzxpress_huffman`
===================================================

.. py:module:: dissect.util.compression.lzxpress_huffman




Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   dissect.util.compression.lzxpress_huffman.Symbol
   dissect.util.compression.lzxpress_huffman.Node
   dissect.util.compression.lzxpress_huffman.BitString



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.util.compression.lzxpress_huffman.decompress



.. py:class:: Symbol

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: length
      :type:  int


   .. py:attribute:: symbol
      :type:  int


.. py:class:: Node(symbol: Symbol | None = None, is_leaf: bool = False)

   .. py:attribute:: __slots__
      :value: ('children', 'is_leaf', 'symbol')



   .. py:attribute:: symbol
      :value: None



   .. py:attribute:: is_leaf
      :value: False



   .. py:attribute:: children
      :value: [None, None]



.. py:class:: BitString

   .. py:attribute:: source
      :value: None



   .. py:attribute:: mask
      :value: 0



   .. py:attribute:: bits
      :value: 0



   .. py:property:: index
      :type: int



   .. py:method:: init(fh: BinaryIO) -> None


   .. py:method:: read(n: int) -> bytes


   .. py:method:: lookup(n: int) -> int


   .. py:method:: skip(n: int) -> None


   .. py:method:: decode(root: Node) -> Symbol


.. py:function:: decompress(src: bytes | BinaryIO) -> bytes

   LZXPRESS decompress from a file-like object or bytes.

   Decompresses until EOF of the input data.

   :param src: File-like object or bytes to decompress.

   :returns: The decompressed data.