| commit | b9dc4c900864ce3305828279128ee7162cf520eb | [log] [tgz] |
|---|---|---|
| author | Travis Bischel <travis.bischel@gmail.com> | Fri Sep 08 22:31:37 2017 -0700 |
| committer | Travis Bischel <travis.bischel@gmail.com> | Fri Sep 08 22:31:37 2017 -0700 |
| tree | e5aa1ce3a716cc68b9cbc240127daafd6a2b0b07 | |
| parent | e30b18214797e64674fdb5f167fb094c5b63c31d [diff] |
TokenTimeout: add doc around new panic My slab bump in #246 added a potential new panic in Core's Inner's `cancel_timeout`. Thankfully, the only way `cancel_timeout` can be called is from TimeoutToken's `cancel_timeout`, which is crate-internal only and is only called from Timeout's and Interval's drop fn's. This change simply adds new clarifying documentation around TokenTimeout's cancel_timeout to "future proof" anybody looking to use cancel_timeout directly (not just on drop).
Core I/O and event loop abstraction for asynchronous I/O in Rust built on futures and mio.
First, add this to your Cargo.toml:
[dependencies] tokio-core = "0.1"
Next, add this to your crate:
extern crate tokio_core;
You can find extensive documentation and examples about how to use this crate online at https://tokio.rs as well as the examples folder in this repository. The API documentation is also a great place to get started for the nitty-gritty.
tokio-core is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.
See LICENSE-APACHE, and LICENSE-MIT for details.