yaaral 0.5.0

yet another async runtime abstraction library
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

<div align="center">

[![stable pipeline](https://gitlab.com/cyloncore/yaaral/badges/stable/pipeline.svg?key_text=stable)](https://gitlab.com/cyloncore/yaaral/-/pipelines?ref=stable)
[![stable pipeline](https://gitlab.com/cyloncore/yaaral/badges/stable/pipeline.svg?key_text=dev/1)](https://gitlab.com/cyloncore/yaaral/-/pipelines?ref=dev/1)
[![docs](https://docs.rs/yaaral/badge.svg)](https://docs.rs/yaaral)
[![crates.io](https://img.shields.io/crates/v/yaaral.svg)](https://crates.io/crates/yaaral)
</div>

yaaral: yet another async runtime abstraction library
=====================================================

yaaral is an abstraction to select between the runtime of `tokio`, `futures-executor` and `std-async`. Its development is driven by the need of the [auKsys](https://auksys.org/) and [CylonCore](https://cyloncore.com/) projects. Feel free to submit any pull requests for your own needs.

Compatibilities
---------------

| yaaral      | futures | tokio |  bevy  |
| ----------- | ------- | ----- | ------ |
| 0.2.x-0.3.x |  0.3.x  |  1.x  | 0.16.x |
| 0.1.x       |  0.3.x  |  1.x  |   -    |

How to use?
-----------

In `cargo.toml`:

### futures-executor

* use the following for support with `futures-executor`:

```toml
yaaral = { version = "0.3", features = ["futures_runtime"] }
```

```rust
use yaaral::{Config, futures::Runtime, prelude::*};
let runtime = Runtime::new(Config::new().prefix("thread-name-"));
```

### tokio

* use the following for support with `tokio`:

```toml
yaaral = { version = "0.2", default-features = false, features = ["tokio_runtime"] }
```

In code, you can start a new runtime with:

```rust
use yaaral::{Config, tokio::Runtime, prelude::*};
let runtime = Runtime::new(Config::new().prefix("thread-name-"));
```

### bevy

* use the following for support with `tokio`:

```toml
yaaral = { version = "0.3", default-features = false, features = ["bevy_runtime"] }
```

```rust,no_run
let runtime = yaaral::bevy::async_compute_task_pool();
let runtime = yaaral::bevy::io_task_pool();
```