:py:mod:`dissect.xfs`
=====================

.. py:module:: dissect.xfs


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   c_xfs/index.rst
   exceptions/index.rst
   xfs/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   dissect.xfs.XFS




.. py:exception:: Error


   Bases: :py:obj:`Exception`

   Common base class for all non-exit exceptions.


.. py:exception:: FileNotFoundError


   Bases: :py:obj:`Error`

   Common base class for all non-exit exceptions.


.. py:exception:: NotADirectoryError


   Bases: :py:obj:`Error`

   Common base class for all non-exit exceptions.


.. py:exception:: NotASymlinkError


   Bases: :py:obj:`Error`

   Common base class for all non-exit exceptions.


.. py:exception:: SymlinkUnavailableException


   Bases: :py:obj:`Error`

   Common base class for all non-exit exceptions.


.. py:exception:: UnsupportedDataforkException


   Bases: :py:obj:`Error`

   Common base class for all non-exit exceptions.


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


   .. py:method:: get(path: Union[int, str], node: Optional[INode] = None) -> INode


   .. py:method:: get_allocation_group(agnum: int) -> AllocationGroup


   .. py:method:: get_inode(absinum: int, *args, **kwargs) -> INode


   .. py:method:: get_relative_inode(agnum: int, inum: int, *args, **kwargs) -> INode


   .. py:method:: walk_agi(block: int, agnum: int) -> Iterator[dissect.cstruct.Instance]


   .. py:method:: walk_extents(block: int) -> Iterator[tuple[int, int, int, int]]


   .. py:method:: walk_large_tree(block: int, leaf_size: int, magic: Optional[list[int]] = None) -> Iterator[bytes]


   .. py:method:: walk_small_tree(block: int, agnum: int, leaf_size: int, magic: Optional[list[int]] = None) -> Iterator[bytes]