async-std/src/lib.rs

67 lines
1.8 KiB
Rust
Raw Normal View History

2019-08-12 18:29:06 +00:00
//! Async version of the Rust standard library.
2019-08-08 12:44:48 +00:00
//!
//! Modules in this crate are organized in the same way as in the standard library, except blocking
//! functions have been replaced with async functions and threads have been replaced with
//! lightweight tasks.
2019-08-16 15:18:39 +00:00
//!
//! More information, reading materials, and other resources:
2019-08-08 12:44:48 +00:00
//!
//! * [🌐 The async-std website](https://async.rs/)
//! * [📖 The async-std book](https://book.async.rs)
//! * [🐙 GitHub repository](https://github.com/async-rs/async-std)
//! * [📒 List of code examples](https://github.com/async-rs/async-std/tree/master/examples)
//! * [💬 Discord chat](https://discord.gg/JvZeVNe)
2019-08-08 12:44:48 +00:00
//!
//! # Examples
//!
//! Spawn a task and block the current thread on its result:
//!
//! ```
//! use async_std::task;
//!
//! fn main() {
//! task::block_on(async {
//! println!("Hello, world!");
//! })
//! }
//! ```
//!
//! # Features
//!
//! Unstable APIs in this crate are available when the `unstable` Cargo feature is enabled:
//!
//! ```toml
//! [dependencies.async-std]
//! version = "0.99"
//! features = ["unstable"]
//! ```
2019-08-08 12:44:48 +00:00
2019-08-12 17:50:30 +00:00
#![cfg_attr(feature = "docs", feature(doc_cfg))]
2019-08-08 12:44:48 +00:00
#![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)]
2019-08-14 02:22:37 +00:00
#![doc(test(attr(deny(rust_2018_idioms, warnings))))]
#![doc(test(attr(allow(unused_extern_crates, unused_variables))))]
2019-08-12 10:43:28 +00:00
#![doc(html_logo_url = "https://async.rs/images/logo--hero.svg")]
2019-08-08 12:44:48 +00:00
use cfg_if::cfg_if;
2019-08-08 12:44:48 +00:00
pub mod fs;
pub mod future;
pub mod io;
pub mod net;
pub mod os;
pub mod prelude;
pub mod stream;
pub mod sync;
pub mod task;
cfg_if! {
if #[cfg(any(feature = "unstable", feature = "docs"))] {
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
pub mod pin;
mod vec;
mod result;
}
}
2019-08-08 12:44:48 +00:00
pub(crate) mod utils;