quranize-rs

Encoding transliterations into Quran forms.

• Crate: https://crates.io/crates/quranize
• Documentation: https://docs.rs/quranize
• Application: https://github.com/quranize/quranize.github.io

Related Project

Former version of this project

• Go: https://github.com/alpancs/quranize
• Application: https://github.com/alpancs/quranize-service

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

lib.rs:

Encodes alphabetic text to quran text. See Quranize for details.

Examples

Adding crate quranize to a project's dependencies

Run cargo add quranize, or add the following lines to Cargo.toml file.

[dependencies]
quranize = "0.11"

Encoding alphabetic text to quran text

let q = quranize::Quranize::default();
assert_eq!(q.encode("alhamdulillah").first().unwrap().0, "الحَمدُ لِلَّهِ");

Getting an aya text given surah number and ayah number

let aya_getter = quranize::AyaGetter::new();
assert_eq!(aya_getter.get(1, 1), Some("بِسمِ اللَّهِ الرَّحمٰنِ الرَّحيمِ"));