:py:mod:`acquire.acquire.volatilestream`
========================================

.. py:module:: acquire.acquire.volatilestream


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

Classes
~~~~~~~

.. autoapisummary::

   acquire.acquire.volatilestream.VolatileStream




Attributes
~~~~~~~~~~

.. autoapisummary::

   acquire.acquire.volatilestream.HAS_FCNTL


.. py:data:: HAS_FCNTL
   :value: True

   

.. py:class:: VolatileStream(path: pathlib.Path, mode: str = 'rb', flags: int = os.O_RDONLY | getattr(os, 'O_NOATIME', 0) | getattr(os, 'O_NONBLOCK', 0), size: int = 1024 * 1024 * 5)


   Bases: :py:obj:`dissect.util.stream.AlignedStream`

   Streaming class to handle various procfs and sysfs edge-cases.  Backed by `AlignedStream`.

   :param path: Path of the file to obtain a file-handle from.
   :param mode: Mode string to open the file-handle with. Such as "rt" and "rb".
   :param flags: Flags to open the file-descriptor with.
   :param size: The maximum size of the stream. None if unknown.

   .. py:method:: seek(pos: int, whence: int = SEEK_SET) -> int

      Seek the stream to the specified position.


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

      Return whether object supports random access.

      If False, seek(), tell() and truncate() will raise OSError.
      This method may need to do a test seek().