:py:mod:`flow.record.adapter.stream`
====================================

.. py:module:: flow.record.adapter.stream


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

Classes
~~~~~~~

.. autoapisummary::

   flow.record.adapter.stream.StreamWriter
   flow.record.adapter.stream.StreamReader




Attributes
~~~~~~~~~~

.. autoapisummary::

   flow.record.adapter.stream.__usage__


.. py:data:: __usage__
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """
        Binary stream adapter (default adapter if none are specified)
        ---
        Write usage: rdump -w stream://[PATH]
        Read usage: rdump stream://[PATH]
        [PATH]: path to file. Leave empty or "-" to output to stdout
        """

    .. raw:: html

        </details>

   

.. py:class:: StreamWriter(path: str, clobber=True, **kwargs)


   Bases: :py:obj:`flow.record.adapter.AbstractWriter`

   .. py:attribute:: fp

      

   .. py:attribute:: stream

      

   .. py:method:: write(record: flow.record.Record) -> None

      Write a record.


   .. py:method:: flush() -> None

      Flush any buffered writes.


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

      Close the Writer, no more writes will be possible.



.. py:class:: StreamReader(path: str, selector: Union[str, flow.record.selector.Selector] = None, **kwargs)


   Bases: :py:obj:`flow.record.adapter.AbstractReader`

   .. py:attribute:: fp

      

   .. py:attribute:: stream

      

   .. py:method:: __iter__() -> Iterator[flow.record.Record]

      Return a record iterator.


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

      Close the Reader, can be overriden to properly free resources.