Coroutine Primitives
====================

Namespace: ``dftracer::utils::coro``

For usage guide and examples, see :doc:`/cpp_api/coro`.

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/async_generator.h#L148>`_

.. doxygenclass:: dftracer::utils::coro::AsyncGenerator
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/async_mutex.h#L70>`_

.. doxygenclass:: dftracer::utils::coro::AsyncMutex
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/async_mutex.h#L107>`_

.. doxygenclass:: dftracer::utils::coro::AsyncMutexGuard
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/async_mutex.h#L148>`_

.. doxygenclass:: dftracer::utils::coro::AsyncMutexLockOperation
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/channel.h#L503>`_

.. doxygenclass:: dftracer::utils::coro::Channel
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/channel.h#L1215>`_

.. doxygenclass:: dftracer::utils::coro::ChannelConsumer
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/channel.h#L1127>`_

.. doxygenclass:: dftracer::utils::coro::ChannelProducer
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/coro.h#L30>`_

.. doxygenclass:: dftracer::utils::coro::Coro
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/coro.h#L78>`_

.. doxygenstruct:: dftracer::utils::coro::CoroPromise
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/task.h#L128>`_

.. doxygenclass:: dftracer::utils::coro::CoroTask
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_all.h#L25-L33>`_

.. doxygenstruct:: dftracer::utils::coro::FireAndForget
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/generator.h#L158>`_

.. doxygenclass:: dftracer::utils::coro::Generator
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/join_handle.h#L86>`_

.. doxygenclass:: dftracer::utils::coro::JoinHandle
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/task.h#L24>`_

.. doxygenstruct:: dftracer::utils::coro::PromiseBase
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/coroutine_traits.h#L215>`_

.. doxygenclass:: dftracer::utils::coro::ReadyAwaitable
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/spawn_future.h#L38>`_

.. doxygenstruct:: dftracer::utils::coro::SharedState
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/spawn_future.h#L124>`_

.. doxygenclass:: dftracer::utils::coro::SpawnFuture
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/yield.h#L42>`_

.. doxygenstruct:: dftracer::utils::coro::SyncScope
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_any.h#L812>`_

.. doxygenclass:: dftracer::utils::coro::TimeoutAwaitable
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_all.h#L484>`_

.. doxygenclass:: dftracer::utils::coro::WhenAllTupleAwaitable
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_all.h#L405>`_

.. doxygenstruct:: dftracer::utils::coro::WhenAllTupleState
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_all.h#L130>`_

.. doxygenclass:: dftracer::utils::coro::WhenAllVectorAwaitable
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_all.h#L46>`_

.. doxygenstruct:: dftracer::utils::coro::WhenAllVectorState
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_any.h#L179>`_

.. doxygenclass:: dftracer::utils::coro::WhenAnyAwaitable
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_any.h#L43>`_

.. doxygenstruct:: dftracer::utils::coro::WhenAnyResult
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_any.h#L74>`_

.. doxygenstruct:: dftracer::utils::coro::WhenAnySharedState
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_any.h#L570>`_

.. doxygenclass:: dftracer::utils::coro::WhenAnyTupleAwaitable
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_any.h#L441>`_

.. doxygenstruct:: dftracer::utils::coro::WhenAnyTupleResult
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/when_any.h#L487>`_

.. doxygenstruct:: dftracer::utils::coro::WhenAnyTupleState
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/yield.h#L68>`_

.. doxygenstruct:: dftracer::utils::coro::YieldAwaitable
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/coroutine_traits.h#L125>`_

.. doxygenstruct:: dftracer::utils::coro::awaitable_result_type
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/coroutine_traits.h#L77>`_

.. doxygenstruct:: dftracer::utils::coro::coro_task_value_type
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/coroutine_traits.h#L93>`_

.. doxygenstruct:: dftracer::utils::coro::generator_value_type
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/coroutine_traits.h#L66>`_

.. doxygenstruct:: dftracer::utils::coro::is_awaitable
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/coroutine_traits.h#L22>`_

.. doxygenstruct:: dftracer::utils::coro::is_coro_task
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/coroutine_traits.h#L196>`_

.. doxygenstruct:: dftracer::utils::coro::is_coroutine_function
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/coroutine_traits.h#L36>`_

.. doxygenstruct:: dftracer::utils::coro::is_generator
   :project: dftracer-utils
   :members:
   :undoc-members:

.. rst-class:: api-source-link

   `source <https://github.com/llnl/dftracer-utils/blob/88a3c8457f8e286301ddc29095a816dca88a5ce9/include/dftracer/utils/core/coro/coroutine_traits.h#L138>`_

.. doxygenstruct:: dftracer::utils::coro::unwrap_coro_task
   :project: dftracer-utils
   :members:
   :undoc-members: