whorl - A single file, std only, async Rust executor

whorl was created to teach you how async executors work in Rust. It is not the fastest executor nor is it's API perfect, but it will teach you about them and how they work and where to get started if you wanted to make your own. It's written in a literate programming style such that reading it from beginning to end tells you a story about how it works or you can read parts of it in chunks depending on what you want to get out of it.

You can read it all online here on GitHub or you can clone the repo yourself and open up src/lib.rs to read through it in your favorite text editor or play around with it and change things. All of the code is licensed under the MIT License so you're mostly free to do with it as you wish. If you want to make the next tokio or just make something for fun you can do that.

If you just want to see it in action an example test program is included as part of the file. You can see it's output by just running:

cargo test -- --nocapture

Which should look something like this:

whorl on  main [!⇡] is 📦 v0.1.0 via 🦀 v1.56.0 took 10s
❯ cargo test -- --nocapture
   Compiling whorl v0.1.0 (/home/michael/whorl)
    Finished test [unoptimized + debuginfo] target(s) in 0.47s
     Running unittests (target/debug/deps/whorl-6d670ffb5bb225ca)

running 1 test
Begin Asynchronous Execution
Blocking Function Polled To Completion
Spawned Fn #00: Start 1635276666
Spawned Fn #01: Start 1635276666
Spawned Fn #02: Start 1635276666
Spawned Fn #03: Start 1635276666
Spawned Fn #04: Start 1635276666
Spawned Fn #00: Ended 1635276669
Spawned Fn #02: Ended 1635276669
Spawned Fn #03: Ended 1635276669
Spawned Fn #01: Ended 1635276670
Spawned Fn #00: Inner 1635276671
Spawned Fn #03: Inner 1635276674
Spawned Fn #04: Ended 1635276675
Spawned Fn #02: Inner 1635276675
Spawned Fn #01: Inner 1635276678
Spawned Fn #04: Inner 1635276678
End of Asynchronous Execution
test library_test ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 23.00s

   Doc-tests whorl

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

This was originally created for my monthly newsletter. You can find that post in particular here or you can sign up for it here.

Comments

Fix typos and punctuation issues

Thanks for the interesting read; I certainly learned a lot!

While reading, I found a few typos and grammatical issues. All of these points are very minor, and I have tried not to change the wording unless necessary.

You'll note that I changed some occurrences of "it's", "get's", and "let's" to "its", "gets" and "lets" respectively. At the risk of being nitpicky, this looked like a common error throughout the writing, so here is an article, which might help explain the difference.

Other than that the text is great and I'm looking forward to a print version. 😉

opened by mre 2
Fix typo

I do not think that there should be uncommenting because the following lines are not commented. Should be there commenting instead?

Anyway, thank you for your awesome example!

opened by wutchzone 1
Change AtomicBool to bool

In previous iterations of whorl we needed an AtomicBool, but since we wrap a Task in an Arc we don't actually need it since we never change the value either. The Task either blocks or does not and that does not change at all. We change to a normal bool and remove any phrasing related to it being an AtomicBool.

Closes #4

opened by mgattozzi 0