safina-executor 0.1.1

Safe async runtime
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

# safina-executor

[![crates.io version](https://img.shields.io/crates/v/safina-executor.svg)](https://crates.io/crates/safina-executor)
[![license: Apache 2.0](https://gitlab.com/leonhard-llc/safina-rs/-/raw/main/license-apache-2.0.svg)](http://www.apache.org/licenses/LICENSE-2.0)
[![unsafe forbidden](https://gitlab.com/leonhard-llc/safina-rs/-/raw/main/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
[![pipeline status](https://gitlab.com/leonhard-llc/safina-rs/badges/main/pipeline.svg)](https://gitlab.com/leonhard-llc/safina-rs/-/pipelines)

This is a safe Rust async executor.

It is part of [`safina`](https://crates.io/crates/safina), a safe async runtime.

## Features
- `forbid(unsafe_code)`
- Depends only on `std`
- Good test coverage (100%)

## Limitations
- Requires Rust `nightly`, for
  [OnceCell](https://doc.rust-lang.org/std/lazy/struct.OnceCell.html)
  and
  [Wake trait](https://doc.rust-lang.org/std/task/trait.Wake.html)
- Allocates memory
- Not optimized

## Documentation
https://docs.rs/safina-executor

## Examples
```rust
safina_executor::increase_threads_to(1);
let (sender, receiver) = std::sync::mpsc::channel();
safina_executor::spawn(Box::pin(async move {
    sender.send(()).unwrap();
}));
receiver.recv().unwrap();
```

```rust
std::thread::spawn(safina_executor::work);
let result = safina_executor::block_on(Box::pin(async {
    prepare_request().await?;
    execute_request().await
}))?;
```

## Alternatives
- [smol](https://crates.io/crates/smol)
  - popular
  - Contains generous amounts of `unsafe` code
- [async-std](https://crates.io/crates/async-std)
  - popular
  - Contains generous amounts of `unsafe` code
- [tokio](https://crates.io/crates/tokio)
  - very popular
  - Fast, internally complicated, and full of `unsafe`
- [nostd_async](https://crates.io/crates/nostd_async)
## Release Process
1. Edit `Cargo.toml` and bump version number.
1. Run `./release.sh`

## Changelog
- v0.1.1 - Fix badge and update readme
- v0.1.0 - Renamed from `safina`

## TO DO
- DONE - Implement `spawn`
- DONE - Implement `block_on`
- DONE - Implement `increase_threads_to`
- DONE - Drop finished futures
- DONE - Handle task panic
- DONE - Add `stop_threads`, `allow_threads`, and `increase_threads_to`.
- DONE - Add tests
- DONE - Add docs
- DONE - Publish on crates.io
- DONE - Add an #[async_test] macro
- Add a stress test
- Add a benchmark
- Make a version of the crate that uses
  unsafe [`once_cell`](https://crates.io/crates/once_cell)
  and unsafe [`RawWaker`](https://doc.rust-lang.org/std/task/struct.RawWaker.html)
  and builds with Rust `stable`.
- Add an #[async_main] macro

License: Apache-2.0