durbat/
lib.rs

1/*!
2# durbat
3
4Durbat is a Rust procedural macro that enables writing Rust using Black Speech keywords,
5identifiers, and module paths from J.R.R. Tolkien's legendarium.
6
7## Quick Start
8
9```rust
10durbat::durbat! {
11    gimb shakh() {
12        krimpat!("Ash nazg durbatulûk!");
13    }
14}
15```
16
17## Features
18
19- Black Speech keywords: `gimb` (fn), `krimp` (let), `ishi` (if), etc.
20- ASCII and diacritic forms: `krîmp`/`krimp`, `dûrbat`/`durbat`
21- Translated module paths: `Zud::Gakh` (std::collections)
22- Full interoperability with standard Rust
23
24For complete documentation, see the [README](https://github.com/itsfoxstudio/durbat).
25
26## Etymology
27
28The name derives from the Ring inscription "Ash nazg durbatulûk" — "to bind them" —
29reflecting the macro's role in binding Black Speech syntax to Rust.
30
31## Legal Notice
32
33This project is a playful homage to J.R.R. Tolkien's legendarium. It is not affiliated
34with or endorsed by the Tolkien Estate. All Black Speech terms are used nominatively.
35*/
36
37pub use durbat_proc_macro::{durbat, dûrbat};