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

.. py:module:: dissect.util.cpio




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

Classes
~~~~~~~

.. autoapisummary::

   dissect.util.cpio.CpioInfo



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.util.cpio.detect_header
   dissect.util.cpio.CpioFile
   dissect.util.cpio.open



Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.util.cpio.FORMAT_CPIO_BIN
   dissect.util.cpio.FORMAT_CPIO_ODC
   dissect.util.cpio.FORMAT_CPIO_NEWC
   dissect.util.cpio.FORMAT_CPIO_CRC
   dissect.util.cpio.FORMAT_CPIO_HPBIN
   dissect.util.cpio.FORMAT_CPIO_HPODC
   dissect.util.cpio.FORMAT_CPIO_UNKNOWN
   dissect.util.cpio.CPIO_MAGIC_OLD
   dissect.util.cpio.CPIO_MAGIC_NEW
   dissect.util.cpio.CPIO_MAGIC_CRC
   dissect.util.cpio.TYPE_MAP


.. py:data:: FORMAT_CPIO_BIN
   :value: 10


.. py:data:: FORMAT_CPIO_ODC
   :value: 11


.. py:data:: FORMAT_CPIO_NEWC
   :value: 12


.. py:data:: FORMAT_CPIO_CRC
   :value: 13


.. py:data:: FORMAT_CPIO_HPBIN
   :value: 16


.. py:data:: FORMAT_CPIO_HPODC
   :value: 17


.. py:data:: FORMAT_CPIO_UNKNOWN
   :value: 18


.. py:data:: CPIO_MAGIC_OLD
   :value: 29127


.. py:data:: CPIO_MAGIC_NEW
   :value: 29121


.. py:data:: CPIO_MAGIC_CRC
   :value: 29122


.. py:data:: TYPE_MAP

.. py:class:: CpioInfo(name='')

   Bases: :py:obj:`tarfile.TarInfo`


   Custom ``TarInfo`` implementation for reading cpio archives.

   Examples::

       tarfile.open(..., tarinfo=CpioInfo)
       # or
       tarfile.TarFile(..., tarinfo=CpioInfo)



   .. py:method:: fromtarfile(tarfile: CpioInfo.fromtarfile.tarfile) -> CpioInfo
      :classmethod:


      Return the next TarInfo object from TarFile object
      tarfile.



   .. py:method:: frombuf(buf: bytes, format: int, encoding: str, errors: str) -> CpioInfo
      :classmethod:


      Construct a TarInfo object from a 512 byte bytes object.




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

      Return True if it is a socket.



.. py:function:: detect_header(fh: BinaryIO) -> int

   Detect a cpio format on a file-like object.


.. py:function:: CpioFile(*args, **kwargs) -> tarfile.TarFile

   Utility wrapper around ``tarfile.TarFile`` to easily open cpio archives.


.. py:function:: open(*args, **kwargs) -> tarfile.TarFile

   Utility wrapper around ``tarfile.open`` to easily open cpio archives.