<h1 align="center">futures-timer</h1>
<div align="center">
  <strong>
    Timeouts for futures.
  </strong>
</div>

<br />

<div align="center">
  <!-- Crates version -->
  <a href="https://crates.io/crates/futures-timer">
    <img src="https://img.shields.io/crates/v/futures-timer.svg?style=flat-square"
    alt="Crates.io version" />
  </a>
  <!-- Downloads -->
  <a href="https://crates.io/crates/futures-timer">
    <img src="https://img.shields.io/crates/d/futures-timer.svg?style=flat-square"
      alt="Download" />
  </a>
  <!-- docs.rs docs -->
  <a href="https://docs.rs/futures-timer">
    <img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square"
      alt="docs.rs docs" />
  </a>
  <a href="https://discord.gg/JvZeVNe">
    <img src="https://img.shields.io/discord/598880689856970762.svg?logo=discord&style=flat-square"
      alt="chat" />
  </a>
</div>

<div align="center">
  <h3>
    <a href="https://docs.rs/futures-timer">
      API Docs
    </a>
    <span> | </span>
    <a href="https://github.com/async-rs/futures-timer/releases">
      Releases
    </a>
    <span> | </span>
    <a href="https://async.rs/contribute">
      Contributing
    </a>
  </h3>
</div>

## Installation

With [cargo add][cargo-add] installed run:

```sh
$ cargo add futures-timer
```

[cargo-add]: https://github.com/killercup/cargo-edit

## Safety
This crate makes use of carefully checked `unsafe` blocks to construct an
efficient timer implementation.

## Contributing
Want to join us? Check out our ["Contributing" guide][contributing] and take a
look at some of these issues:

- [Issues labeled "good first issue"][good-first-issue]
- [Issues labeled "help wanted"][help-wanted]

[contributing]: https://github.com/async-rs/futures-timer/blob/master.github/CONTRIBUTING.md
[good-first-issue]: https://github.com/async-rs/futures-timer/labels/good%20first%20issue
[help-wanted]: https://github.com/async-rs/futures-timer/labels/help%20wanted

## License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br/>

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