genawaiter-macro

Crates.iogenawaiter-macro
lib.rsgenawaiter-macro
version0.99.1
sourcesrc
created_at2020-02-16 22:49:16.23501
updated_at2020-03-09 00:03:50.696289
descriptionConvenience macros for generators (genawaiter)
homepage
repositoryhttps://github.com/whatisaphone/genawaiter
max_upload_size
id209905
size3,349
John Simon (whatisaphone)

documentation

README

genawaiter

crate-badge docs-badge ci-badge

This crate implements stackless generators (aka coroutines) in stable Rust. Instead of using yield, which won't be stabilized anytime soon, you use async/await, which is stable today.

Features:

  • supports resume arguments and completion values
  • allocation-free
  • no runtime dependencies
    • no compile-time dependencies either, with default-features = []
  • built on top of standard language constructs, which means there are no platform-specific shenanigans

Example:

let odd_numbers_less_than_ten = gen!({
    let mut n = 1;
    while n < 10 {
        yield_!(n); // Suspend a function at any point with a value.
        n += 2;
    }
});

// Generators can be used as ordinary iterators.
for num in odd_numbers_less_than_ten {
    println!("{}", num);
}

Result:

1
3
5
7
9

See the docs for more.

Development

Install prerequisites

Install the pre-commit hook

pre-commit install

This installs a Git hook that runs a quick sanity check before every commit.

Run the app

cargo run

Run the tests

cargo test
Commit count: 146

cargo fmt