safina 0.1.4

# safina

[![crates.io version](https://img.shields.io/crates/v/safina.svg)](https://crates.io/crates/safina)
[![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)

A safe Rust async runtime.

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

## 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.  You can avoid allocations by using advanced functions, like
  [`safina_executor::spawn_unpin`](https://docs.rs/safina-executor/latest/safina_executor/fn.spawn_unpin.html).
- Not optimized

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

[`safina_async_test`](https://crates.io/crates/safina_async_test)
has an `#[async_test]` macro for running `async fn` test functions.

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

```rust
std::thread::spawn(safina_executor::work);
let result = safina::block_on(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)
  - Very popular
  - Contains generous amounts of `unsafe` code
- [tokio](https://crates.io/crates/tokio)
  - Very popular
  - Fast
  - Internally extremely complicated
  - Full of `unsafe`
- [nostd_async](https://crates.io/crates/nostd_async)

## Changelog
- v0.1.3 - Update readme
- v0.1.2 - Renamed `safina` crate to `safina-executor`.
  Added new `safina` crate with re-exports, examples, and integration tests.
- v0.1.1 - Add badges to readme
- v0.1.0 - First published version

## TO DO
- Add an integration test
- Add `init` function that starts worker threads and the timer thread.
- Make it work on Rust stable
- Add an #[async_main] macro

## Release Process
1. Edit `Cargo.toml` and bump version number.
1. Run `./release.sh`

License: Apache-2.0