Rust I18n is a crate for loading localized text from a set of YAML mapping files. The mappings are converted into data readable by Rust programs at compile time, and then localized text can be loaded by simply calling the provided t! macro.
The API of this crate is inspired by ruby-i18n and Rails I18n.
t! macro for loading localized text in everywhere.cargo i18n Command line tool for checking and extract untranslated texts into YAML files.Rust I18n also provided a cargo i18n command line tool help you process translations.
bash
$ cargo install rust-i18n
Add crate dependencies in your Cargo.toml and setup I18n config:
```toml [dependencies] once_cell = "1.10.0" rust-i18n = "0"
[package.metadata.i18n]
```
Load macro and init translations in lib.rs
``rs
// Load I18n macro, for allow you uset!` macro in anywhere.
extern crate rust_i18n;
// Init translations for current crate. i18n!("locales"); ```
Or you can import by use directly:
``rs
// You must import in each files when you wants uset!` macro.
use rust_i18n::t;
rust_i18n::i18n!("locales");
fn main() { println!("{}", t!("hello")); } ```
Make sure all YAML files (containing the localized mappings) are located in the locales/ folder of the project root directory:
.
├── Cargo.lock
├── Cargo.toml
├── locales
│ ├── en.yml
│ ├── zh-CN.yml
│ └── zh-HK.yml
└── src
└── main.rs
In the YAML files, specify the localization keys and their corresponding values, for example, in en.yml:
yml
hello: Hello world # A simple key -> value mapping
messages:
hello: Hello, %{name} # A nested key.sub_key -> value mapping, in this case "messages.hello" maps to "Hello, %{name}"
And example of the zh-CN.yml:
yml
hello: 你好世界
messages:
hello: 你好, %{name}
Import the t! macro from this crate into your current scope:
rs
use rust_i18n::t;
Then, simply use it wherever a localized string is needed:
```rs t!("hello"); // => "Hello world"
t!("hello", locale = "zh-CN"); // => "你好世界"
t!("messages.hello", name = "world"); // => "Hello, world"
t!("messages.hello", locale = "zh-CN", name = "Jason"); // => "你好, Jason" ```
You can use rust_i18n::set_locale to set the global locale at runtime, so that you don't have to specify the locale on each t! invocation.
```rs rusti18n::setlocale("zh-CN");
let locale = rusti18n::locale(); asserteq!(locale, "zh-CN"); ```
Rust I18n providered a i18n bin for help you extract the untranslated texts from the source code and then write into YAML file.
```bash $ cargo install rust-i18n
cargo i18n command```
After that the untranslated texts will be extracted and saved into locales/TODO.en.yml file.
You also can special the locale by use --locale option:
```bash $ cd yourprojectroot_directory $ cargo i18n
Checking [en] and generating untranslated texts...
Writing to TODO.en.yml
Checking [fr] and generating untranslated texts...
Writing to TODO.fr.yml
Checking [zh-CN] and generating untranslated texts... All thing done.
Checking [zh-HK] and generating untranslated texts...
Writing to TODO.zh-HK.yml ```
Run cargo i18n -h to see details.
```bash $ cargo i18n -h
Rust I18n command for help you simply to extract all untranslated texts from soruce code.
It will iter all Rust files in and extract all untranslated texts that used t! macro.
And then generate a YAML file and merge for existing texts.
https://github.com/longbridgeapp/rust-i18n
USAGE: cargo i18n [OPTIONS] [--] [source]
FLAGS: -h, --help Prints help information -V, --version Prints version information
ARGS:
The RUST_I18N_DEBUG environment variable can be used to print out some debugging infos when code is being generated at compile time.
bash
$ RUST_I18N_DEBUG=1 cargo build
A minimal example of using rust-i18n can be found here.
MIT