:py:mod:`dissect.apfs.util`
===========================

.. py:module:: dissect.apfs.util




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


Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.apfs.util.fletcher64
   dissect.apfs.util.make_fs_object_key
   dissect.apfs.util.parse_fs_object_key
   dissect.apfs.util.cmp_default
   dissect.apfs.util.cmp_omap
   dissect.apfs.util.cmp_fs
   dissect.apfs.util.cmp_fs_extent
   dissect.apfs.util.cmp_fext
   dissect.apfs.util.cmp_fs_dir
   dissect.apfs.util.cmp_fs_dir_hash



.. py:function:: fletcher64(data: bytes) -> int

   Compute the Fletcher-64 checksum of the given data.


.. py:function:: make_fs_object_key(oid: int, type: dissect.apfs.c_apfs.c_apfs.APFS_TYPE) -> dissect.apfs.c_apfs.c_apfs.j_key

   Create a ``j_key`` struct for the given object ID and type.


.. py:function:: parse_fs_object_key(data: bytes) -> tuple[int, dissect.apfs.c_apfs.c_apfs.APFS_TYPE]

   Parse an object ID and type from a ``j_key`` struct.


.. py:function:: cmp_default(key: bytes, other: bytes) -> Literal[-1, 0, 1]

   Default comparison function for B-tree keys.


.. py:function:: cmp_omap(key: tuple[int, int], other: bytes) -> Literal[-1, 0, 1]

   Comparison function for OMAP keys.


.. py:function:: cmp_fs(key: tuple[int, int], other: bytes) -> Literal[-1, 0, 1]

   Comparison function for FS object keys.


.. py:function:: cmp_fs_extent(key: tuple[tuple[int, int], int], other: bytes) -> Literal[-1, 0, 1]

   Comparison function for FS extent keys.


.. py:function:: cmp_fext(key: tuple[int, int], other: bytes) -> Literal[-1, 0, 1]

   Comparison function for sealed file extent keys.


.. py:function:: cmp_fs_dir(key: tuple[tuple[int, int], bytes], other: bytes) -> Literal[-1, 0, 1]

   Comparison function for FS directory entries.


.. py:function:: cmp_fs_dir_hash(key: tuple[tuple[int, int], int, bytes | None], other: bytes) -> Literal[-1, 0, 1]

   Comparison function for FS directory entries.