oxedyne/fe2o3/fe2o3_o3db_sync/README.md
1.6 KiB, 9 runs
created by r1870400018:653, 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 crate provides a log-structured key-value database inspired by BitCask, designed for high throughput and reliability. The database aims to: |
| 8 | |
| 9 | - Write data quickly by appending to log-structured operating system files |
| 10 | - Leverage operating system threads extensively for high parallelism |
| 11 | - Maintain as much data as possible in a fast volatile cache |
| 12 | - Provide automatic file garbage collection |
| 13 | - Offer a simple, familiar key-value interface with robust error handling |
| 14 | |
| 15 | Key features include: |
| 16 | - Automatic chunking of large values |
| 17 | - Support for encryption including post-quantum options |
| 18 | - Built-in checksum verification |
| 19 | - Configurable garbage collection |
| 20 | - Comprehensive error handling with error tags and chaining |
| 21 | |
| 22 | The crate is part of the Hematite collection but can be used independently for applications requiring a fast, reliable key-value store with strong correctness guarantees. |
| 23 | |
| 24 | ## Supporting Development |
| 25 | |
| 26 | 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. |
| 27 | |
| 28 |  |
| 29 | |
| 30 | ## License |
| 31 | |
| 32 | See the [LICENSE](LICENSE) file for license rights and limitations. |
| 33 | |
| 34 | ## Contact |
| 35 | |
| 36 | <hello@oxedyne.com> |