oxedyne/fe2o3/fe2o3_core/README.md
1.6 KiB, 9 runs
created by r1870400018:54, which is this file's identity for as long as the history lasts, whatever it is later renamed to
download · who wrote it · its history
| 1 | # Oxedyne Hematite (fe2o3) |
| 2 | |
| 3 | Hematite is a collection of crates built from first principles, providing foundational tools for building robust applications. See the [github repo](https://github.com/Oxedyne/fe2o3) for more information. |
| 4 | |
| 5 | ## This crate |
| 6 | |
| 7 | This is a foundational crate providing core functionality used throughout the Hematite ecosystem: |
| 8 | |
| 9 | - Rich error handling with tags and error chaining via `Outcome<T>` and `Error<T>` |
| 10 | - A flexible logging system with console and file output support |
| 11 | - Thread and bot management with message passing primitives |
| 12 | - Generic data structures and traits including maps, counters, and alternates |
| 13 | - Numeric type utilities and bounds checking |
| 14 | - String and path manipulation helpers |
| 15 | - Byte handling and conversion traits |
| 16 | - Testing utilities with filtering and assertion support |
| 17 | - A derive macro for generating `new()` constructors |
| 18 | |
| 19 | Core types include `Outcome<T>` for error handling, `Logger` for logging, `Counter` for numeric iteration, and `SimplexThread` for thread management. The error system allows tagging errors with multiple categories and chaining them together while preserving context through propagation. |
| 20 | |
| 21 | ## Supporting Development |
| 22 | |
| 23 | This project is developed and maintained through GitHub Sponsors. If you find Hematite valuable for your work or interesting as a project, consider supporting its continued development. No special perks or privileges - just sustainable open source development of innovative Rust infrastructure and apps. |
| 24 | |
| 25 |  |
| 26 | |
| 27 | ## License |
| 28 | |
| 29 | See the [LICENSE](LICENSE) file for license rights and limitations. |
| 30 | |
| 31 | ## Contact |
| 32 | |
| 33 | <hello@oxedyne.com> |