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

.. py:module:: acquire.acquire.outputs.dir


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

Classes
~~~~~~~

.. autoapisummary::

   acquire.acquire.outputs.dir.DirectoryOutput




.. py:class:: DirectoryOutput(path: pathlib.Path, **kwargs)


   Bases: :py:obj:`acquire.outputs.base.Output`

   Base class to implement acquire output formats with.

   New output formats must sub-class this class.

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

      Write a file-like object to a directory.

      The data from ``fh`` is written, while ``entry`` is used to get some properties of the file.

      On Windows platforms ``:`` is replaced with ``_`` in the output_path.

      :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:: close() -> None

      Closes the output.