:py:mod:`dissect.apfs.objects.nx_superblock`
============================================

.. py:module:: dissect.apfs.objects.nx_superblock




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

Classes
~~~~~~~

.. autoapisummary::

   dissect.apfs.objects.nx_superblock.NxSuperblock




.. py:class:: NxSuperblock(container: dissect.apfs.apfs.APFS, address: int, *, block: bytes | None = None, cipher: dissect.fve.crypto.Cipher | None = None)

   Bases: :py:obj:`dissect.apfs.objects.base.Object`


   APFS NX Superblock object.


   .. py:attribute:: __type__


   .. py:attribute:: __struct__


   .. py:attribute:: object
      :type:  dissect.apfs.c_apfs.c_apfs.nx_superblock


   .. py:method:: check() -> None

      Check the validity of the superblock.



   .. py:method:: compare(other: NxSuperblock) -> None

      Compare this superblock to another superblock.



   .. py:property:: block_size
      :type: int


      The block size of the container.


   .. py:property:: block_count
      :type: int


      The total number of blocks in the container.


   .. py:property:: features
      :type: dissect.apfs.c_apfs.c_apfs.NX_FEATURE


      The features supported by this container.


   .. py:property:: incompatible_features
      :type: dissect.apfs.c_apfs.c_apfs.NX_INCOMPAT


      The incompatible features supported by this container.


   .. py:property:: uuid
      :type: uuid.UUID


      The UUID of the container.


   .. py:property:: checkpoint_objects
      :type: list[dissect.apfs.objects.checkpoint_map.CheckpointMap | NxSuperblock]


      All checkpoint objects in the container.


   .. py:property:: ephemeral_objects
      :type: dict[int, dissect.apfs.objects.base.Object]


      All ephemeral objects in the container.


   .. py:property:: omap
      :type: dissect.apfs.objects.omap.ObjectMap


      The object map of the container.


   .. py:property:: filesystems
      :type: list[dissect.apfs.objects.fs.FS]


      All the filesystems in the container.


   .. py:property:: fusion_uuid
      :type: uuid.UUID


      The Fusion Drive UUID.


   .. py:property:: keylocker
      :type: dissect.apfs.objects.keybag.ContainerKeybag | None


      The container keybag, if present.