LocalFmt: Provide simple localizable format strings

Overview

local-fmt is a Rust library that provides a mechanism for defining and using localizable format strings. It is designed to facilitate the creation of applications that support multiple languages by allowing developers to define messages in a structured and maintainable way.

Crate cfg feature

• macros: include gen_const_messa, gen_message and def_local_fmt macros if you use def_local_fmt, chose from below
• macros-toml: parseable toml at def_local_fmt
• macros-json: parseable json at def_local_fmt
• macros-yaml: parseable yaml def_local_fmt

Features

• Localizable Messages: Define messages in multiple languages using TOML or JSON files.
• Dynamic Language Switching: Change the language at runtime using a dynamic supplier.
• Compile-time Checks: Ensure message format correctness at compile time.
• Integration with Serde: Optional support for serializing and deserializing messages.

Usage

Below is an example of how to use local-fmt in a Rust project. This example demonstrates creating a localizable format string and using it to format a message.

#![cfg(feature = "macros")]
#![cfg(feature = "macros-toml")]
/// This example demonstrates how to use the `local-fmt` library to create
/// and use localizable format strings in a Rust application.

use std::sync::RwLock;
use enum_table::Enumable;
use local_fmt::{def_local_fmt, ConstMessage};

#[derive(Clone, Copy, Enumable)]
enum Lang {
    EN,
    JA,
}

struct Messages {
    pub hello: ConstMessage<1>,
}

static LANG: RwLock<Lang> = RwLock::new(Lang::EN);

def_local_fmt!(
    name = MESSAGES,
    lang = Lang,
    message = Messages,
    supplier = || *LANG.read().unwrap(),
    file_type = "toml",
    lang_folder = "doctest/langs"
);

fn main() {
    // Use the `MESSAGES` to create a personalized greeting message.
    assert_eq!(MESSAGES.hello.format(&["Rust"]), "Hello, world! Rust");

    // Change the language to Japanese
    *LANG.write().unwrap() = Lang::JA;

    // Print the greeting message in Japanese
    assert_eq!(MESSAGES.hello.format(&["Rust"]), "こんにちは、世界！ Rust");
}

For more detailed information on def_local_fmt, see the documentation.

Documentation

For more detailed information, please refer to the documentation.

License

Licensed under

• MIT license