41 lines
1.2 KiB
Markdown
41 lines
1.2 KiB
Markdown
# boilerext
|
|
|
|
Rlib with useful boilerplate extension traits for QoL.
|
|
|
|
Support for `no_std` environments with most extensions preserved.
|
|
|
|
Aims to extend methods that have negligible performance cost, which only
|
|
reasonable barrier is their lenthyness or unintuitiveness.
|
|
|
|
Uses unsafe rust where its safetyness is immediately obvious to squeeze
|
|
performance without fear of breaking safety contracts if the abstracted method
|
|
wasn't there.
|
|
|
|
# Docs
|
|
|
|
Documentation is not hosted publicly for now, clone and run `cargo doc` to
|
|
generate it.
|
|
|
|
# Installation
|
|
|
|
```sh
|
|
cargo add --git https://git.javalsai.tuxcord.net/rust/boilerext
|
|
```
|
|
|
|
# Development
|
|
|
|
This project uses cargo test/miri test/doc/fmt/check/clippy, codespell, prettier
|
|
and shellcheck to check and help in development.
|
|
|
|
You can check for everything (as long as you have the tools) with
|
|
`scripts/check.sh`. For additional stuff pass `extra` as the first argument to
|
|
said script.
|
|
|
|
# License
|
|
|
|
This code is licensed under the MIT license, a copy can be found at the root of
|
|
this project.
|
|
|
|
The philosophy of the project is just to provide small extension traits with
|
|
accessibility ease, so the MIT license was chosen to avoid legal friction.
|