mirror/async-std
2
0
Fork 1
mirror of https://github.com/async-rs/async-std.git synced 2025-10-31 00:36:38 +00:00
Code Issues Releases Wiki Activity

Add docs to feature section

Browse source
This commit is contained in:
James Munns 2019-11-12 01:39:38 +01:00
parent 6b0a81012b
commit 3c92ffeb5c
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/lib.rs
View file

@ -171,6 +171,18 @@
//! features = ["attributes"]
//! ```
//!
//! When the `serde` feature is enabled, it is possible to use `async_std` types such as [`path::PathBuf`]
//! within types that are serialized or deserialized using [`serde`] compatible crates.
//!
//! [`serde`]: https://serde.rs
//! [`path::PathBuf`]: path/struct.PathBuf.html
//!
//! ```toml
//! [dependencies.async-std]
//! version = "1.0.0"
//! features = ["serde"]
//! ```
//!
//! Additionally it's possible to only use the core traits and combinators by
//! only enabling the `std` Cargo feature:
//!