:py:mod:`flow.record.tools.rdump`
=================================

.. py:module:: flow.record.tools.rdump




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

Classes
~~~~~~~

.. autoapisummary::

   flow.record.tools.rdump.ProgressMonitor



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   flow.record.tools.rdump.list_adapters
   flow.record.tools.rdump.main
   flow.record.tools.rdump.print_error



Attributes
~~~~~~~~~~

.. autoapisummary::

   flow.record.tools.rdump.version
   flow.record.tools.rdump.HAS_TQDM
   flow.record.tools.rdump.HAS_STRUCTLOG
   flow.record.tools.rdump.log


.. py:data:: version
   :value: 'unknown'


.. py:data:: HAS_TQDM
   :value: True


.. py:data:: HAS_STRUCTLOG
   :value: True


.. py:data:: log

.. py:function:: list_adapters() -> None

.. py:class:: ProgressMonitor(ctx: flow.record.context.AppContext, progress_bar: tqdm, update_interval: float = 0.2)

   Periodically update ``progress_bar`` with the record metrics from ``ctx``.


   .. py:attribute:: ctx


   .. py:attribute:: progress_bar


   .. py:attribute:: update_interval
      :value: 0.2



   .. py:attribute:: should_stop


   .. py:attribute:: thread
      :value: None



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


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


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


.. py:function:: main(argv: list[str] | None = None) -> int

.. py:function:: print_error(e: Exception) -> None