# future-bool
[![crate][crate-image]][crate-link]
[![docs][docs-image]][docs-link]

A bool one can `await` the changes.

## Example usage
```rust
use future_bool::FutureBool;

#[tokio::main]
async fn main() {
    let run = FutureBool::new(false);
    let run_clone = run.clone();

    let task = tokio::spawn(async move {
        loop {
            // If run changes to false before `some_async_fn` is terminated, 
            // it will be interrupted.
            tokio::select! {
                _ = run_clone.wait_false() => break,
                _ = some_async_fn() => {}
            };
        }
    });

    // ... some other task sets run to false with 
    // `run.unset()`
    task.await;
}
```


[crate-image]: https://img.shields.io/crates/v/future-bool.svg
[crate-link]: https://crates.io/crates/future-bool

[docs-image]: https://docs.rs/future-bool/badge.svg
[docs-link]: https://docs.rs/future-bool