added example and updated README.md

Author: nurmohammed840

README.md

@@ -1,5 +1,9 @@
 This library provides a way to create asynchronous generator using the `async/await` feature in stable Rust.
 
+It is similar to [async-stream](https://docs.rs/async-stream/latest/async_stream/),
+But closely mimics the [Coroutine API](https://doc.rust-lang.org/std/ops/trait.Coroutine.html),
+Allowing the generator also return a value upon completion, in addition to yielding intermediate values.
+
 # Installation
 
 Add it as a dependency to your Rust project by adding the following line to your `Cargo.toml` file:

examples/tcp_accept.rs

@@ -0,0 +1,20 @@
+use async_gen::gen;
+use futures_util::StreamExt;
+use std::pin::pin;
+use tokio::net::TcpListener;
+
+#[tokio::main]
+async fn main() {
+    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
+
+    let mut incoming = pin!(gen! {
+        loop {
+            let (socket, _) = listener.accept().await.unwrap();
+            yield socket;
+        }
+    });
+
+    while let Some(v) = incoming.next().await {
+        println!("handle = {:?}", v);
+    }
+}

tests/stream.rs

@@ -39,6 +39,19 @@ fn yield_single_value() {
     })
 }
 
+#[test]
+fn fused() {
+    block_on(async {
+        let s = pin!(gen! {
+            yield "hello";
+        });
+        let mut s = s.fuse();
+        assert_eq!(s.next().await, Some("hello"));
+        assert_eq!(s.next().await, None);
+        assert_eq!(s.next().await, None);
+    });
+}
+
 #[test]
 fn yield_multi_value() {
     block_on(async {
@@ -178,24 +191,3 @@ fn yield_with_select() {
         assert_eq!(values, vec!["hey"]);
     })
 }
-
-// #[test]
-// fn inner_try_stream() {
-//     use async_stream::try_stream;
-//     use tokio::select;
-
-//     async fn do_stuff_async() {}
-
-//     let _ = stream! {
-//         select! {
-//             _ = do_stuff_async() => {
-//                 let another_s = try_stream! {
-//                     yield;
-//                 };
-//                 let _: Result<(), ()> = Box::pin(another_s).next().await.unwrap();
-//             },
-//             else => {},
-//         }
-//         yield
-//     };
-// }

tests/try_stream.rs

@@ -23,7 +23,7 @@ fn yield_then_err() {
         let mut s = pin!(gen! {
             yield "hello";
             Err("world")?;
-            Result::<_, &str>::Ok(())
+            Ok(())
         });
         assert_eq!(s.resume().await, GeneratorState::Yielded("hello"));
         assert_eq!(s.resume().await, GeneratorState::Complete(Err("world")));