Struct Config

pub struct Config {
    pub path: String,
    pub language: String,
}

Localization config object.

Use Config::new() to create config objects instead of using this struct.

Parameters

• path: The directory containing the translation files. The directory is relative to the path the executable was executed from.
• language: The language to translate to.

Returns

A new Config object with the specified path and language.

Examples

localizer_rs::Config {
    path: "path".to_owned(),
    language: "language".to_owned()
};

Fields

path: String

The directory containing the translation files. The directory is relative to the path the executable was executed from.

language: String

The language to translate to.

Implementations

impl Config

pub fn new(path: &str, language: &str) -> Config

Creates a new config object.

Parameters

• path: The directory containing the translation files. The directory is relative to the path the executable was executed from.
• language: The language to translate to.

Returns

A new Config object with the specified path and language.

Panics

Panics if the Path provided is invalid.

Examples

localizer_rs::Config::new("examples/translations", "language");

See also

• Config

Examples found in repository

examples/main.rs (line 4)

fn main() {
    let config: localizer_rs::Config = localizer_rs::Config::new("translations", "en");

    println!(
        "{:}",
        localizer_rs::t!(
            config,
            "error",
            "details" = "Something went wrong when trying to do stuff"
        )
    );
    println!(
        "{:}",
        localizer_rs::t!(config, "success", "balance" = "$10", "user" = "John Doe")
    );

    println!("{:}", localizer_rs::t!(config, "all"));
}

pub fn set_path(&mut self, str_path: &str) -> &Config

Sets the path for the config object.

Parameters

• self: The config object. This must be mutable.
• str_path: The directory containing the translation files. The directory is relative to the path the executable was executed from.

Returns

The modified Config object with the specified path.

Panics

Panics if the Path provided is invalid.

Examples

config.set_path("examples");

See also

• Config

pub fn set_language(&mut self, language: &str) -> &Config

Sets the language for the config object.

Parameters

• self: The config object. This must be mutable.
• language: The language to translate to.

Returns

The modified Config object with the specified language.

Examples

config.set_language("en");

See also

• Config

pub fn t(&self, key: &str, arguments: Vec<(&str, &str)>) -> String

Translates the specified key in the language specified in the config.

Parameters

• self: The config object.
• key: The key to translate to.
• arguments: The arguments to replace.

Returns

A String containing the translated value.

Examples

config.t("test", vec![]);

See also

• t!()
• Config

pub fn translate(&self, key: &str, arguments: Vec<(&str, &str)>) -> String

Translates the specified key in the language specified in the config.

Parameters

• self: The config object.
• key: The key to translate to.
• arguments: The arguments to replace.

Returns

A String containing the translated value.

Raises

This method throws an exception and exits if

• The translation file could not be found
• The translation file could not be opened
• The translation file could not be parsed
• The parsed json could not be converted to a json value
• The converted json could not be indexed

Examples

config.translate("test", vec![]);

See also

• t!()
• Config
• Config::t()
• serde_json

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for Config

fn cmp(&self, other: &Config) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Config

fn partial_cmp(&self, other: &Config) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Config

impl StructuralPartialEq for Config