cuprate-hinto-janai/helper/README.md

22 lines
851 B
Markdown
Raw Normal View History

## Helper
`helper/` is the kitchen-sink crate for very generic, not necessarily Cuprate specific functions, types, etc.
This allows all workspace crates to share, and aids compile times.
If a 3rd party's crate/functions/types are small enough, it could be moved here to trim dependencies and allow easy modifications.
## Features
2024-09-25 22:04:35 +00:00
Modules can be selectively used/compiled with cargo's `--feature` or `features = ["..."]`.
2024-09-25 22:04:35 +00:00
All features are off by default.
See [`Cargo.toml`](Cargo.toml)'s `[features]` table to see what features there are and what they enable.
2024-09-25 22:04:35 +00:00
Special non-module related features:
- `serde`: Enables serde implementations on applicable types
- `std`: Enables usage of `std`
## `#[no_std]`
Each modules documents whether it requires `std` or not.
If a module that requires `std` is enabled, `helper` will automatically use `std`.