cuprate/helper
hinto-janai 4876e159e7
repo: add skeleton directories, fix labels (#139)
* `database/` -> `storage/`, create skeleton `storage/` crates

* add skeleton root directories

* books: add skeleton

* ci: fix labeler.yml

* fix CONTRIBUTING.md

* fix workspace Cargo.toml

* fix `storage/`

* rename helper fs fn, `cuprate_database` -> `cuprate_blockchain`

* fix Cargo.toml

* cuprate-blockchain: revert find-and-replace

Since it has to be ported to the book anyway, there's not much
reason to update this and create review diffs.

* labeler.yml: remove `A-docs` from `books/` changes

Although books are documentation,
the `A-books` label already exists for this
2024-05-29 02:18:30 +01:00
..
src repo: add skeleton directories, fix labels (#139) 2024-05-29 02:18:30 +01:00
build.rs helper: add constants & COMMIT (#64) 2024-02-15 21:44:43 +00:00
Cargo.toml database: impl service fn bodies (#113) 2024-05-01 18:52:20 +01:00
README.md helper/ (#45) 2024-01-21 00:04:09 +00:00

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'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.