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

.. py:module:: dissect.cim.index




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

Classes
~~~~~~~

.. autoapisummary::

   dissect.cim.index.Index
   dissect.cim.index.Store
   dissect.cim.index.IndexPage
   dissect.cim.index.Key




.. py:class:: Index(cim: dissect.cim.cim.CIM, fh: BinaryIO, mapping: dissect.cim.mappings.Mapping)

   .. py:attribute:: store


   .. py:method:: lookup(key: Key) -> list[Key]


.. py:class:: Store(cim: dissect.cim.cim.CIM, fh: BinaryIO, mapping: dissect.cim.mappings.Mapping)

   .. py:attribute:: cim


   .. py:attribute:: fh


   .. py:attribute:: map


   .. py:attribute:: root_page


   .. py:method:: page(logical_num: int) -> IndexPage


   .. py:method:: read_page(page_num: int) -> io.BytesIO


.. py:class:: IndexPage(store: Store, fh: BinaryIO, logical_num: int, page_num: int)

   .. py:attribute:: store


   .. py:attribute:: fh


   .. py:attribute:: logical_num


   .. py:attribute:: page_num


   .. py:attribute:: page


   .. py:attribute:: data


   .. py:attribute:: count


   .. py:attribute:: key


   .. py:method:: string(idx: int) -> str


   .. py:method:: keys() -> collections.abc.Iterator[Key]


   .. py:method:: child(idx: int) -> int


   .. py:method:: children() -> list[int]


.. py:class:: Key(cim: dissect.cim.cim.CIM, *parts: str)

   .. py:attribute:: cim


   .. py:attribute:: key
      :value: ''



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


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


   .. py:method:: __getitem__(item: int) -> str


   .. py:method:: parts() -> dict[str, str]


   .. py:method:: reference() -> Key | None


   .. py:method:: references() -> list[Key]


   .. py:method:: object() -> io.BytesIO


   .. py:method:: objects() -> collections.abc.Iterator[tuple[Key, io.BytesIO]]


   .. py:property:: is_data_reference
      :type: bool



   .. py:property:: data_page
      :type: int



   .. py:property:: data_id
      :type: int



   .. py:property:: data_length
      :type: int



   .. py:method:: NS(name: str | None = None) -> Key


   .. py:method:: CD(name: str | None = None) -> Key


   .. py:method:: CI(name: str | None = None) -> Key


   .. py:method:: IL(name: str | None = None) -> Key