:py:mod:`tierkreis.worker.storage.protocol`
===========================================

.. py:module:: tierkreis.worker.storage.protocol

.. autodoc2-docstring:: tierkreis.worker.storage.protocol
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`WorkerStorage <tierkreis.worker.storage.protocol.WorkerStorage>`
     -

API
~~~

.. py:class:: WorkerStorage
   :canonical: tierkreis.worker.storage.protocol.WorkerStorage

   Bases: :py:obj:`typing.Protocol`

   .. py:method:: read_call_args(path: pathlib.Path) -> tierkreis.controller.data.location.WorkerCallArgs
      :canonical: tierkreis.worker.storage.protocol.WorkerStorage.read_call_args

      .. autodoc2-docstring:: tierkreis.worker.storage.protocol.WorkerStorage.read_call_args

   .. py:method:: read_input(path: pathlib.Path) -> bytes
      :canonical: tierkreis.worker.storage.protocol.WorkerStorage.read_input

      .. autodoc2-docstring:: tierkreis.worker.storage.protocol.WorkerStorage.read_input

   .. py:method:: write_output(path: pathlib.Path, value: bytes) -> None
      :canonical: tierkreis.worker.storage.protocol.WorkerStorage.write_output

      .. autodoc2-docstring:: tierkreis.worker.storage.protocol.WorkerStorage.write_output

   .. py:method:: glob(path_string: str) -> list[str]
      :canonical: tierkreis.worker.storage.protocol.WorkerStorage.glob

      .. autodoc2-docstring:: tierkreis.worker.storage.protocol.WorkerStorage.glob

   .. py:method:: mark_done(path: pathlib.Path) -> None
      :canonical: tierkreis.worker.storage.protocol.WorkerStorage.mark_done

      .. autodoc2-docstring:: tierkreis.worker.storage.protocol.WorkerStorage.mark_done

   .. py:method:: write_error(path: pathlib.Path, error_logs: str) -> None
      :canonical: tierkreis.worker.storage.protocol.WorkerStorage.write_error

      .. autodoc2-docstring:: tierkreis.worker.storage.protocol.WorkerStorage.write_error

   .. py:attribute:: __slots__
      :canonical: tierkreis.worker.storage.protocol.WorkerStorage.__slots__
      :value: ()

   .. py:method:: __init_subclass__(*args, **kwargs)
      :canonical: tierkreis.worker.storage.protocol.WorkerStorage.__init_subclass__
      :classmethod:

   .. py:method:: __class_getitem__(item)
      :canonical: tierkreis.worker.storage.protocol.WorkerStorage.__class_getitem__
      :classmethod: