#async #macro #self #enabled #features #traits #maybe-async

macro winter-maybe-async

sync/async macro for winterfell

2 unstable releases

new 0.10.0 Jun 11, 2024
0.9.0 May 9, 2024

#1432 in Procedural macros

Download history 190/week @ 2024-05-08 18/week @ 2024-05-15 175/week @ 2024-05-22 235/week @ 2024-05-29

618 downloads per month
Used in 2 crates (via winter-prover)

MIT license

6KB

Winter maybe-async

This crate contains the maybe_async procedural attribute macro and the maybe_await procedural macro which abstract away Rust sync/async.

maybe_async

The maybe_async macro will conditionally add the async keyword to a function it marks depending on the async feature being enabled. To generate the asynchronous version, enable the async feature on the crate. If the async feature is off, the synchronous version will be generated. For example,

// Adding `maybe_async` to trait functions
trait ExampleTrait {
    #[maybe_async]
    fn say_hello(&self);

    #[maybe_async]
    fn get_hello(&self) -> String;
}

// Adding `maybe_async` to regular functions
#[maybe_async]
fn hello_world() {
    // ...
}

When the async feature is enabled, the above code will be transformed into:

trait ExampleTrait {
    async fn say_hello(&self);

    async fn get_hello(&self) -> String;
}

async fn hello_world() {
    // ...
}

maybe_await

To compliment maybe_async we also have the maybe_await procedural macro that conditionally adds the .await keyword to the end of an expression depending on the async feature flag.

#[maybe_async]
fn hello_world() {
    // Adding `maybe_await` to an expression
    let w = maybe_await!(world());

    println!("hello {}", w);
}

#[maybe_async]
fn world() -> String {
    "world".to_string()
}

When the async feature is enabled, the above code will be transformed into:

async fn hello_world() {
    let w = world().await;

    println!("hello {}", w);
}

async fn world() -> String {
    "world".to_string()
}

License

This project is MIT licensed.

Dependencies

~305–760KB
~18K SLoC