14 releases (7 stable)

1.1.0 Mar 17, 2024
1.0.5 Sep 2, 2023
1.0.4 Mar 18, 2023
1.0.0 Jan 4, 2022
0.1.2 Oct 4, 2019

#87 in Rust patterns

Download history 343557/week @ 2023-12-05 322158/week @ 2023-12-12 274102/week @ 2023-12-19 185213/week @ 2023-12-26 306055/week @ 2024-01-02 320507/week @ 2024-01-09 378688/week @ 2024-01-16 415492/week @ 2024-01-23 401475/week @ 2024-01-30 359193/week @ 2024-02-06 350588/week @ 2024-02-13 362994/week @ 2024-02-20 395046/week @ 2024-02-27 398198/week @ 2024-03-05 404525/week @ 2024-03-12 361363/week @ 2024-03-19

1,627,549 downloads per month
Used in 1,253 crates (432 directly)

MIT/Apache

18KB
243 lines

async-recursion macro

Latest version crates.io downloads Build Status Apache/MIT2.0 License

Procedural macro for recursive async functions.

Motivation

Consider the following recursive implementation of the fibonacci numbers:

async fn fib(n : u32) -> u32 {
   match n {
       0 | 1 => 1,
       _ => fib(n-1).await + fib(n-2).await
   }
}

The compiler helpfully tells us that:

error[E0733]: recursion in an `async fn` requires boxing
 --> src/main.rs:1:26
  |
1 | async fn fib(n : u32) -> u32 {
  |                          ^^^ recursive `async fn`
  |
  = note: a recursive `async fn` must be rewritten to return a boxed `dyn Future`
  = note: consider using the `async_recursion` crate: https://crates.io/crates/async_recursion

This crate provides an attribute macro to automatically convert an async function to one returning a boxed Future.

Example

use async_recursion::async_recursion;

#[async_recursion]
async fn fib(n : u32) -> u32 {
   match n {
      0 | 1 => 1,
      _ => fib(n-1).await + fib(n-2).await
   }
}

?Send option

The returned Future has a Send bound to make sure it can be sent between threads. If this is undesirable you can mark that the bound should be left out like so:

#[async_recursion(?Send)]
async fn returned_future_is_not_send() {
   // ...
}

Sync option

The returned Future doesn't have a Sync bound as it is usually not required. You can include a Sync bound as follows:

#[async_recursion(Sync)]
async fn returned_future_is_sync() {
   // ...
}

In detail:

  • #[async_recursion] modifies your function to return a boxed Future with a Send bound.
  • #[async_recursion(?Send)] modifies your function to return a boxed Future without a Send bound.
  • #[async_recursion(Sync)] modifies your function to return a boxed Future with a Send and Sync bound.

License

Licensed under either of

at your option.

Dependencies

~0.4–0.8MB
~19K SLoC