Merge pull request #22 from sjinks/remove-sync-generator-adapter

fix: remove `sync_generator_adapter`

Author: sjinks

README.md

@@ -87,8 +87,7 @@ The documentation is available at [https://sjinks.github.io/coro-cpp/](https://s
 
 ### Eager Coroutine (`eager_task`)
 
-An *eager coroutine* start execution immediately upon creation and does not suspend upon completion. From the caller's perspective,
-it runs synchoronously; the control is returned to the caller only after the coroutine finishes.
+An *eager coroutine* (or *hot-start coroutine*) starts execution immediately upon creation and keeps running until the first suspending `co_await`.
 
 ```cpp
 #include <wwa/coro/eager_task.h>
@@ -135,7 +134,7 @@ wwa::coro::task<> print()
 }
 ```
 
-It is possible to turn any task (or any awaitable) into a fire-anf-forget eager coroutine. For the example above,
+It is possible to turn any task (or any awaitable) into a fire-and-forget eager coroutine. For the example above,
 
 ```cpp
 #include <wwa/coro/eager_task.h>
@@ -226,28 +225,3 @@ while (it != end) {
 See [examples/async_generator.cpp](https://github.com/sjinks/coro-cpp/blob/master/examples/async_generator.cpp).
 
 Unfortunately, it is impossible to use asynchronous iterators directly in range-based `for` loops.
-However, this limitation can be overcome with the help of eager coroutines.
-
-There is a helper adapter, `sync_generator_adapter<T>`, that turns an asynchronous generator into a quasi-synchronous one:
-
-```cpp
-#include <wwa/coro/async_generator.h>
-#include <wwa/coro/sync_generator_adapter.h>
-
-wwa::coro::async_generator<int> async_iota(int start = 0)
-{
-    for (int i = start;; ++i) {
-        co_yield i;
-    }
-}
-
-// ...
-
-wwa::coro::sync_generator_adapter<int> sync_iota(async_iota(10));
-
-for (auto& n : sync_iota | std::views::take(5)) {
-    std::cout << n << "\n";
-}
-```
-
-See [examples/sync_generator_adapter.cpp](https://github.com/sjinks/coro-cpp/blob/master/examples/sync_generator_adapter.cpp).

examples/CMakeLists.txt

@@ -12,9 +12,6 @@ target_compile_features(eager_task PRIVATE cxx_std_20)
 add_executable(run_awaitable run_awaitable.cpp)
 target_compile_features(run_awaitable PRIVATE cxx_std_20)
 
-add_executable(sync_generator_adapter sync_generator_adapter.cpp)
-target_compile_features(sync_generator_adapter PRIVATE cxx_std_20)
-
 add_executable(async_generator async_generator.cpp)
 target_compile_features(async_generator PRIVATE cxx_std_20)
 

examples/advance_with_begin.cpp

@@ -4,7 +4,6 @@
 #include "async_generator.h"
 #include "eager_task.h"
 #include "generator.h"
-#include "sync_generator_adapter.h"
 #include "task.h"
 
 namespace {
@@ -62,22 +61,6 @@ void iterate_over_sync()
     std::cout << "\n";
 }
 
-void iterate_over_adapted_async()
-{
-    //! [Iterate over adapted asynchronous generator with begin()]
-    auto async = async_first_n(5);
-    auto gen   = wwa::coro::sync_generator_adapter(std::move(async));
-    auto it    = gen.begin();
-    auto end   = gen.end();
-
-    do {
-        std::cout << *it << " ";
-    } while (gen.begin() != end);
-    //! [Iterate over adapted asynchronous generator with begin()]
-
-    std::cout << "\n";
-}
-
 }  // namespace
 
 int main()
@@ -86,16 +69,12 @@ int main()
     iterate_over_async();
     std::cout << "Iterating over synchronous generator:\n";
     iterate_over_sync();
-    std::cout << "Iterating over adapted asynchronous generator:\n";
-    iterate_over_adapted_async();
 
     // Expected output:
     // Iterating over asynchronous generator:
     // 0 1 2 3 4
     // Iterating over synchronous generator:
     // 0 1 2 3 4
-    // Iterating over adapted asynchronous generator:
-    // 0 1 2 3 4
 
     return 0;
 }

examples/sync_generator_adapter.cpp

@@ -28,7 +28,6 @@ target_sources(
             eager_task.h
             exceptions.h
             generator.h
-            sync_generator_adapter.h
             task.h
 )
 

src/CMakeLists.txt

@@ -13,9 +13,6 @@
  * Example usage:
  * @snippet async_generator.cpp asynchronous generator example
  * @snippet{trimleft} async_generator.cpp asynchronous generator usage
- *
- * With the help of `sync_generator_adapter`, you can adapt an asynchronous generator to use it in a synchronous context
- * (e.g., range-based for loops or views).
  */
 
 #include <coroutine>

src/async_generator.h

@@ -22,8 +22,7 @@ namespace wwa::coro {
 /**
  * @brief Eager coroutine.
  *
- * This class represents an eager coroutine, which starts execution immediately upon creation and does not suspend upon completion.
- * From the caller's perspective, it runs synchoronously; the control is returned to the caller only after the coroutine finishes.
+ * This class represents an eager coroutine, which starts execution immediately upon creation and and keeps running until the first suspending `co_await`.
  *
  * Example:
  * @snippet eager_task.cpp eager_task example
@@ -134,7 +133,7 @@ eager_task run_awaitable(Awaitable&& f, Args&&... args)
 
 /**
  * @example run_awaitable.cpp
- * Shows how to use `run_awaitable` to turn any awaitable into an eager coroutine that runs synchronously from the caller's perspective.
+ * Shows how to use `run_awaitable` to turn any awaitable into an eager coroutine.
  */
 
 }  // namespace wwa::coro