PeachCloud
/
peach-workspace
3
2
Fork 1
Code Issues 17 Pull Requests Projects Releases Wiki Activity

add docs about feature flags

This commit is contained in:
glyph 2021-12-09 09:54:53 +02:00
parent 0907fbc474
commit 8c3fecb875
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
peach-stats/README.md
View File

@ -32,6 +32,16 @@ fn main() -> Result<(), StatsError> {
}
```
## Feature Flags
Feature flags are used to offer `Serialize` and `Deserialize` implementations for all `struct` data types provided by this library. These traits are not provided by default. A choice of `miniserde` and `serde` is provided.
Define the desired feature in the `Cargo.toml` manifest of your project:
```toml
peach-stats = { version = "0.1.0", features = ["miniserde_support"] }
```
## License
LGPL-3.0.

12
peach-stats/src/lib.rs
View File

@ -29,6 +29,18 @@
//! Ok(())
//! }
//! ```
//!
//! ## Feature Flags
//!
//! Feature flags are used to offer `Serialize` and `Deserialize` implementations
//! for all `struct` data types provided by this library. These traits are not
//! provided by default. A choice of `miniserde` and `serde` is provided.
//!
//! Define the desired feature in the `Cargo.toml` manifest of your project:
//!
//! ```toml
//! peach-stats = { version = "0.1.0", features = ["miniserde_support"] }
//! ```
pub mod error;
pub mod stats;