fast-async-mutex 0.4.1

The fast async mutex which uses spinlock algorithm with using waker
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

# fast-async-mutex
[![](https://github.com/Mnwa/fast-async-mutex/workflows/build/badge.svg?branch=master)](https://github.com/Mnwa/fast-async-mutex/actions?query=workflow%3Abuild)
[![](https://docs.rs/fast-async-mutex/badge.svg)](https://docs.rs/fast-async-mutex/)
[![](https://img.shields.io/crates/v/fast-async-mutex.svg)](https://crates.io/crates/fast-async-mutex)
[![](https://img.shields.io/crates/d/fast-async-mutex.svg)](https://crates.io/crates/fast-async-mutex)

The fast async mutex which uses atomics with spinlock algorithm. 
Spinlock algorithm integrated with the Rust futures concept without the overhead of any libs. Also when the `MutexGuard` is dropped,
a waker of the next locker will be executed.
It will be works with any async runtime in `Rust`, it may be a `tokio`, `smol`, `async-std` and etc..


## Examples

```rust
use fast_async_mutex::mutex::Mutex;

#[tokio::main]
async fn main() {
    let mutex = Mutex::new(10);
    let guard = mutex.lock().await;
    assert_eq!(*guard, 10);
}
```

## Benchmarks

There is result of benchmarks which runs on `MacBook Pro (16-inch, 2019) 2,3 GHz 8-Core Intel Core i9 16GB RAM`
Tests you can find in the [benchmarks dir](benchmarks).
```
running 15 tests
test fast_async_mutex::tests::concurrency_without_waiting            ... bench:   1,586,483 ns/iter (+/- 118,637)
test fast_async_mutex::tests::create                                 ... bench:           0 ns/iter (+/- 0)
test fast_async_mutex::tests::step_by_step_without_waiting           ... bench:     168,055 ns/iter (+/- 33,155)
test fast_async_mutex_unordered::tests::concurrency_without_waiting  ... bench:   1,525,709 ns/iter (+/- 116,901)
test fast_async_mutex_unordered::tests::create                       ... bench:           0 ns/iter (+/- 0)
test fast_async_mutex_unordered::tests::step_by_step_without_waiting ... bench:      84,197 ns/iter (+/- 22,894)
test futures::tests::concurrency_without_waiting                     ... bench:   1,659,640 ns/iter (+/- 127,051)
test futures::tests::create                                          ... bench:          91 ns/iter (+/- 9)
test futures::tests::step_by_step_without_waiting                    ... bench:     206,003 ns/iter (+/- 28,685)
test smol::tests::concurrency_without_waiting                        ... bench:   1,861,629 ns/iter (+/- 160,359)
test smol::tests::create                                             ... bench:           0 ns/iter (+/- 0)
test smol::tests::step_by_step_without_waiting                       ... bench:     367,434 ns/iter (+/- 69,082)
test tokio::tests::concurrency_without_waiting                       ... bench:  22,798,759 ns/iter (+/- 2,861,692)
test tokio::tests::create                                            ... bench:          87 ns/iter (+/- 27)
test tokio::tests::step_by_step_without_waiting                      ... bench:     733,205 ns/iter (+/- 126,314)

test result: ok. 0 passed; 0 failed; 0 ignored; 15 measured; 0 filtered out
```

## License

Licensed under either of

 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

#### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.