Update explanation to show async block expansion

dtolnay · Dec 30, 2023 · 381fd75 · 381fd75
1 parent 3caf301
commit 381fd75
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -118,7 +118,7 @@ can't be that badly broken.
 ## Explanation
 
 Async fns get transformed into methods that return `Pin<Box<dyn Future + Send +
-'async_trait>>` and delegate to a private async freestanding function.
+'async_trait>>` and delegate to an async block.
 
 For example the `impl Advertisement for AutoplayingVideo` above would be
 expanded as:
@@ -131,11 +131,9 @@ impl Advertisement for AutoplayingVideo {
     where
         Self: Sync + 'async_trait,
     {
-        async fn run(_self: &AutoplayingVideo) {
+        Box::pin(async move {
             /* the original method body */
-        }
-
-        Box::pin(run(self))
+        })
     }
 }
 ```

diff --git a/src/lib.rs b/src/lib.rs
@@ -133,7 +133,7 @@
 //! # Explanation
 //!
 //! Async fns get transformed into methods that return `Pin<Box<dyn Future +
-//! Send + 'async_trait>>` and delegate to a private async freestanding function.
+//! Send + 'async_trait>>` and delegate to an async block.
 //!
 //! For example the `impl Advertisement for AutoplayingVideo` above would be
 //! expanded as:
@@ -147,11 +147,9 @@
 //!     where
 //!         Self: Sync + 'async_trait,
 //!     {
-//!         async fn run(_self: &AutoplayingVideo) {
+//!         Box::pin(async move {
 //!             /* the original method body */
-//!         }
-//!
-//!         Box::pin(run(self))
+//!         })
 //!     }
 //! }
 //! # };