:py:mod:`acquire.acquire.outputs.base`
======================================

.. py:module:: acquire.acquire.outputs.base


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

Classes
~~~~~~~

.. autoapisummary::

   acquire.acquire.outputs.base.Output




.. py:class:: Output


   Base class to implement acquire output formats with.

   New output formats must sub-class this class.

   .. py:method:: init(path: pathlib.Path, **kwargs) -> None


   .. py:method:: write(output_path: str, fh: BinaryIO, entry: Optional[Union[dissect.target.filesystem.FilesystemEntry, pathlib.Path]], size: Optional[int] = None) -> None
      :abstractmethod:

      Write a file-like object to the output.

      :param output_path: The path of the entry in the output.
      :param fh: The file-like object of the entry to write.
      :param entry: The optional filesystem entry to write.
      :param size: The optional file size in bytes of the entry to write.


   .. py:method:: write_entry(output_path: str, entry: Union[dissect.target.filesystem.FilesystemEntry, pathlib.Path], size: Optional[int] = None) -> None

      Write a filesystem entry to the output.

      :param output_path: The path of the entry in the output.
      :param entry: The filesystem entry to write.
      :param size: The optional file size in bytes of the entry to write.


   .. py:method:: write_bytes(output_path: str, data: bytes, entry: Optional[Union[dissect.target.filesystem.FilesystemEntry, pathlib.Path]] = None, size: Optional[int] = None) -> None

      Write raw bytes to the output format.

      :param output_path: The path of the entry in the output.
      :param data: The raw bytes to write.
      :param entry: The optional filesystem entry to write.
      :param size: The optional file size in bytes of the entry to write.


   .. py:method:: write_volatile(output_path: str, entry: Union[dissect.target.filesystem.FilesystemEntry, pathlib.Path], size: Optional[int] = None) -> None

      Write a filesystem entry to the output.

      Handles files that live in volatile filesystems. Such as procfs and sysfs.

      :param output_path: The path of the entry in the output.
      :param entry: The filesystem entry to write.
      :param size: The optional file size in bytes of the entry to write.


   .. py:method:: close() -> None
      :abstractmethod:

      Closes the output.