cuprate/helper/README.md

## 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`.
`helper/` (#45) * add `/helper/` * add `num.rs` * add `sys.rs` * add `crypto.rs` * add lints and mod to `lib.rs` * `sys` -> `time`, add more free functions straight from https://docs.rs/readable/latest/readable/time/index.html * num: add `Number/Float` types, `cmp_float()`, `cmp_float_nan()` * `common/src/tower_utils.rs` -> `helper/src/asynch.rs` * gate modules with `#[cfg(feature = "...")]` * add `thread.rs` * cargo fmt * thread: test out of 100 * add `atomic.rs` * atomic: fix `fetch_update()` * atomic: impl `fetch_()` for atomic floats `#[no_std]` where possible * asynch: remove `InstaFuture` https://docs.rs/futures/latest/futures/future/fn.ready.html * crypto: remove `check_point()` * thread: return percent computation without static * thread: add `low_priority_thread()` https://docs.rs/lpt * add rayon_spawn_async, remove crypto * remove current_time_try --------- Co-authored-by: Boog900 <54e72d8a-345f-4599-bd90-c6b9bc7d0ec5@aleeas.com> 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`](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`.