52 lines
1.6 KiB
Markdown
52 lines
1.6 KiB
Markdown
|
<div align="center">
|
||
|
|
|
||
|
|
<h1><code>gloo-timers</code></h1>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
<a href="https://crates.io/crates/gloo-timers"><img src="https://img.shields.io/crates/v/gloo-timers.svg?style=flat-square" alt="Crates.io version" /></a>
|
||
|
|
<a href="https://crates.io/crates/gloo-timers"><img src="https://img.shields.io/crates/d/gloo-timers.svg?style=flat-square" alt="Download" /></a>
|
||
|
|
<a href="https://docs.rs/gloo-timers"><img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square" alt="docs.rs docs" /></a>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<h3>
|
||
|
|
<a href="https://docs.rs/gloo-timers">API Docs</a>
|
||
|
|
<span> | </span>
|
||
|
|
<a href="https://github.com/rustwasm/gloo/blob/master/CONTRIBUTING.md">Contributing</a>
|
||
|
|
<span> | </span>
|
||
|
|
<a href="https://discordapp.com/channels/442252698964721669/443151097398296587">Chat</a>
|
||
|
|
</h3>
|
||
|
|
|
||
|
|
<sub>Built with 🦀🕸 by <a href="https://rustwasm.github.io/">The Rust and WebAssembly Working Group</a></sub>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
Working with timers on the Web: `setTimeout` and `setInterval`.
|
||
|
|
|
||
|
|
These APIs come in two flavors:
|
||
|
|
|
||
|
|
1. a callback style (that more directly mimics the JavaScript APIs), and
|
||
|
|
2. a `Future`s and `Stream`s API.
|
||
|
|
|
||
|
|
### Timeouts
|
||
|
|
|
||
|
|
Timeouts fire once after a period of time (measured in milliseconds).
|
||
|
|
|
||
|
|
#### Timeouts with a Callback Function
|
||
|
|
|
||
|
|
```rust
|
||
|
|
use gloo_timers::callback::Timeout;
|
||
|
|
|
||
|
|
let timeout = Timeout::new(1_000, move || {
|
||
|
|
// Do something after the one second timeout is up!
|
||
|
|
});
|
||
|
|
|
||
|
|
// Since we don't plan on cancelling the timeout, call `forget`.
|
||
|
|
timeout.forget();
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Timeouts as `Future`s
|
||
|
|
|
||
|
|
With the `futures` feature enabled, a `future` module containing futures-based
|
||
|
|
timers is exposed.
|
||
|
|
|