cuprate/helper
Boog900 44981f2b24
CI: add cargo hack (#170)
* add workflow

* fix errors

* fix workflow

* install dependencies

* fix more errors

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-authored-by: hinto-janai <hinto.janai@protonmail.com>

* fix hack + enable it for cuprate-database

* move hack to main CI

* fix docs

* fix ci formatting

* fix txpool tests

* fix CONTRIBUTING.md formatting

* service -> tower::Service

* review fixes

* review fixes

* fix CI

---------

Co-authored-by: hinto-janai <hinto.janai@protonmail.com>
2024-11-01 20:22:14 +00:00
..
src CI: add cargo hack (#170) 2024-11-01 20:22:14 +00:00
Cargo.toml CI: add cargo hack (#170) 2024-11-01 20:22:14 +00:00
README.md types: JSON representation types (#300) 2024-10-05 01:47:44 +01: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

Modules can be selectively used/compiled with cargo's --feature or features = ["..."].

All features are off by default.

See Cargo.toml's [features] table to see what features there are and what they enable.

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.