:py:mod:`dissect.thumbcache.index`
==================================

.. py:module:: dissect.thumbcache.index


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

Classes
~~~~~~~

.. autoapisummary::

   dissect.thumbcache.index.ThumbnailIndex
   dissect.thumbcache.index.IndexEntry




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.thumbcache.index.INDEX_ENTRIES
   dissect.thumbcache.index.MAX_IMM_OFFSET
   dissect.thumbcache.index.BYTES_IN_NUMBER
   dissect.thumbcache.index.IDENTIFIER_BYTES


.. py:data:: INDEX_ENTRIES

   

.. py:data:: MAX_IMM_OFFSET
   :value: 4

   

.. py:data:: BYTES_IN_NUMBER
   :value: 4

   

.. py:data:: IDENTIFIER_BYTES
   :value: 8

   

.. py:class:: ThumbnailIndex(fh: BinaryIO)


   .. py:property:: header
      :type: dissect.cstruct.Structure


   .. py:property:: version
      :type: int


   .. py:property:: type
      :type: dissect.thumbcache.util.ThumbnailType


   .. py:property:: total_entries
      :type: int


   .. py:property:: used_entries
      :type: int


   .. py:method:: entries() -> Iterator[IndexEntry]

      Returns all index entries that are actually used.



.. py:class:: IndexEntry(fh: BinaryIO, type: dissect.thumbcache.util.ThumbnailType)


   .. py:property:: header
      :type: dissect.cstruct.Structure


   .. py:property:: identifier
      :type: bytes


   .. py:property:: flags
      :type: int


   .. py:property:: cache_offsets
      :type: list[int]

      Retrieves the index data entries.

      These are offsets into the thumbcache files, where the order specifies in which of the files.
      More information about the order can be found in :class:`Thumbcache`.

   .. py:property:: last_modified
      :type: datetime.datetime


   .. py:method:: in_use() -> bool


   .. py:method:: __repr__() -> str

      Return repr(self).