#rocket #multi-language #static #json-text #json

json-gettext

A library for getting text from JSON usually for internationalization

58 stable releases

4.0.10 Dec 10, 2023
4.0.8 Nov 3, 2023
4.0.6 Sep 9, 2023
4.0.5 Nov 2, 2022
1.7.0 Oct 15, 2018

#23 in Internationalization (i18n)

Download history 10/week @ 2024-06-04 223/week @ 2024-06-11 64/week @ 2024-06-18 213/week @ 2024-06-25 87/week @ 2024-07-02 189/week @ 2024-07-09 207/week @ 2024-07-16 47/week @ 2024-07-23 33/week @ 2024-07-30 22/week @ 2024-08-06 17/week @ 2024-08-13 12/week @ 2024-08-20 8/week @ 2024-08-27 63/week @ 2024-09-03 79/week @ 2024-09-10 22/week @ 2024-09-17

173 downloads per month
Used in 3 crates (2 directly)

MIT license

79KB
2K SLoC

JSON Get Text

CI

This is a library for getting text from JSON usually for internationalization.

Example

#[macro_use] extern crate json_gettext;

let ctx = static_json_gettext_build!(
    "en_US";
    "en_US" => "langs/en_US.json",
    "zh_TW" => "langs/zh_TW.json"
).unwrap();

assert_eq!("Hello, world!", get_text!(ctx, "hello").unwrap());
assert_eq!("哈囉,世界!", get_text!(ctx, "zh_TW", "hello").unwrap());

Rocket Support

This crate supports the Rocket framework. In order to reload changed json files instead of recompiling the program you have to enable the rocket feature for this crate.

[dependencies.json-gettext]
version = "*"
features = ["rocket"]

Then, use the static_json_gettext_build_for_rocket macro instead of the static_json_gettext_build macro to build a JSONGetText(JSONGetTextManager).

#[macro_use] extern crate json_gettext;

#[macro_use] extern crate rocket;

use rocket::State;
use rocket::response::Redirect;

use json_gettext::JSONGetTextManager;

#[get("/")]
fn index(ctx: &State<JSONGetTextManager>) -> Redirect {
    Redirect::temporary(uri!(hello(lang = ctx.get_default_key())))
}

#[get("/<lang>")]
fn hello(ctx: &State<JSONGetTextManager>, lang: String) -> String {
    format!("Ron: {}", get_text!(ctx, lang, "hello").unwrap().as_str().unwrap())
}

#[launch]
fn rocket() -> _ {
    rocket::build()
        .attach(static_json_gettext_build_for_rocket!(
            "en_US";
            "en_US" => "langs/en_US.json",
            "zh_TW" => "langs/zh_TW.json"
        ))
        .mount("/", routes![index, hello])
}

If you are not using the release profile, JSONGetTextManager can reload the json files automatically if needed.

unic-langid Support

Since string comparison could be slow, the language_region_pair feature, the language feature or the region feature can be enabled to change key's type to (Language, Option<Region>), Language or Region respectively where Language and Region structs are in the unic-langid crate.

In this case, the key! macro would be useful for generating a Key instance from a literal string.

For example,

[dependencies.json-gettext]
version = "*"
features = ["language_region_pair", "rocket"]
#[macro_use]
extern crate rocket;

#[macro_use]
extern crate rocket_accept_language;

#[macro_use]
extern crate json_gettext;

use rocket::State;

use rocket_accept_language::unic_langid::subtags::Language;
use rocket_accept_language::AcceptLanguage;

use json_gettext::{JSONGetTextManager, Key};

const LANGUAGE_EN: Language = language!("en");

#[get("/")]
fn index(ctx: &State<JSONGetTextManager>, accept_language: &AcceptLanguage) -> String {
    let (language, region) = accept_language.get_first_language_region().unwrap_or((LANGUAGE_EN, None));

    format!("Ron: {}", get_text!(ctx, Key(language, region), "hello").unwrap().as_str().unwrap())
}

#[launch]
fn rocket() -> _ {
    rocket::build()
        .attach(static_json_gettext_build_for_rocket!(
            key!("en");
            key!("en") => "langs/en_US.json",
            key!("zh_TW") => "langs/zh_TW.json",
        ))
        .mount("/", routes![index])
}

Crates.io

https://crates.io/crates/json-gettext

Documentation

https://docs.rs/json-gettext

License

MIT

Dependencies

~3–35MB
~545K SLoC