oxedyne/fe2o3/fe2o3_syntax/README.md
1.5 KiB, 9 runs
created by r1870400018:1025, 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 protocol-oriented syntax system that unifies command handling for both textual REPL interfaces and network communications. It allows you to define a `Syntax` that specifies commands, arguments, and expected values in a structured way, while maintaining direct control over command handling. The library deliberately avoids callback mechanisms in favour of explicit command matching, promoting simplicity and transparency in command processing flows. |
| 8 | |
| 9 | Key features: |
| 10 | - Define commands with strongly-typed arguments and values |
| 11 | - Parse both text and binary message formats |
| 12 | - Support for short and long-form argument styles |
| 13 | - Built-in help text generation |
| 14 | - Seamless operation across local REPL and network contexts |
| 15 | |
| 16 | ## Supporting Development |
| 17 | |
| 18 | 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. |
| 19 | |
| 20 |  |
| 21 | |
| 22 | ## License |
| 23 | |
| 24 | See the [LICENSE](LICENSE) file for license rights and limitations. |
| 25 | |
| 26 | ## Contact |
| 27 | |
| 28 | <hello@oxedyne.com> |