:py:mod:`mass_driver.models.scan`
=================================

.. py:module:: mass_driver.models.scan

.. autodoc2-docstring:: mass_driver.models.scan
   :parser: myst
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`Scanner <mass_driver.models.scan.Scanner>`
     - .. autodoc2-docstring:: mass_driver.models.scan.Scanner
          :parser: myst
          :summary:
   * - :py:obj:`ScanFile <mass_driver.models.scan.ScanFile>`
     - .. autodoc2-docstring:: mass_driver.models.scan.ScanFile
          :parser: myst
          :summary:
   * - :py:obj:`ScanLoaded <mass_driver.models.scan.ScanLoaded>`
     - .. autodoc2-docstring:: mass_driver.models.scan.ScanLoaded
          :parser: myst
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`ScannerFunc <mass_driver.models.scan.ScannerFunc>`
     - .. autodoc2-docstring:: mass_driver.models.scan.ScannerFunc
          :parser: myst
          :summary:

API
~~~

.. py:data:: ScannerFunc
   :canonical: mass_driver.models.scan.ScannerFunc
   :value: None

   .. autodoc2-docstring:: mass_driver.models.scan.ScannerFunc
      :parser: myst

.. py:class:: Scanner
   :canonical: mass_driver.models.scan.Scanner

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: mass_driver.models.scan.Scanner
      :parser: myst

   .. py:attribute:: name
      :canonical: mass_driver.models.scan.Scanner.name
      :type: str
      :value: None

      .. autodoc2-docstring:: mass_driver.models.scan.Scanner.name
         :parser: myst

   .. py:attribute:: func
      :canonical: mass_driver.models.scan.Scanner.func
      :type: mass_driver.models.scan.ScannerFunc
      :value: None

      .. autodoc2-docstring:: mass_driver.models.scan.Scanner.func
         :parser: myst

.. py:class:: ScanFile
   :canonical: mass_driver.models.scan.ScanFile

   Bases: :py:obj:`pydantic.BaseModel`

   .. autodoc2-docstring:: mass_driver.models.scan.ScanFile
      :parser: myst

   .. py:attribute:: scanner_names
      :canonical: mass_driver.models.scan.ScanFile.scanner_names
      :type: list[str]
      :value: None

      .. autodoc2-docstring:: mass_driver.models.scan.ScanFile.scanner_names
         :parser: myst

.. py:class:: ScanLoaded
   :canonical: mass_driver.models.scan.ScanLoaded

   Bases: :py:obj:`mass_driver.models.scan.ScanFile`

   .. autodoc2-docstring:: mass_driver.models.scan.ScanLoaded
      :parser: myst

   .. py:attribute:: scanners
      :canonical: mass_driver.models.scan.ScanLoaded.scanners
      :type: list[mass_driver.models.scan.Scanner]
      :value: None

      .. autodoc2-docstring:: mass_driver.models.scan.ScanLoaded.scanners
         :parser: myst