susync 0.1.2

An util crate to complete futures through a handle. Its main purpose is to bridge async Rust and callback-based APIs.
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

# Overview
An util crate to complete futures through a handle. Its main purpose is to bridge async Rust and callback-based APIs.

Inspired on the `future_handles` crate.

The `susync` crate uses standard library channels under the hood. It uses thread-safe primitives but expects low contention,
so it uses a single `SpinMutex` for shared state.
By design handles are allowed to race to complete the future so it is ok to call `complete` on handle of a completed future.

## Examples

Channel-like API:
```rust
async fn func() -> Option<u32> {
    let (future, handle) = susync::create();
    func_with_callback(|res| {
        handle.complete(res);
    });
    future.await.ok()
}
```

Scoped API:
```rust
async fn func() -> Option<u32> {
    let future = susync::suspend(|handle| {
        func_with_callback(|res| {
            handle.complete(res);
        });
    });
    future.await.ok()
}
```

## Docs
Full documentation [here](https://docs.rs/susync/).