mirror of
https://github.com/hinto-janai/cuprate.git
synced 2024-12-23 03:59:37 +00:00
18 lines
712 B
Markdown
18 lines
712 B
Markdown
|
## 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
|
||
|
Code can be selectively used/compiled with cargo's `--feature` or `features = ["..."]`.
|
||
|
|
||
|
All features on by default.
|
||
|
|
||
|
See [`Cargo.toml`](Cargo.toml)'s `[features]` table to see what features there are and what they enable.
|
||
|
|
||
|
## `#[no_std]`
|
||
|
Each modules documents whether it requires `std` or not.
|
||
|
|
||
|
If a module that requires `std` is enabled, `helper` will automatically use `std`.
|