Struct Localizer

pub struct Localizer {
    initialized: bool,
    data: HashMap<String, Rc<str>>,
}

An object that localizes strings. It reads localization data from a directory and provides localized strings. If the localization data is not found, it will demangle the key using an algorithm that tries to approximate the intended text

Fields

initialized: bool

Whether at least a single file has been loaded

data: HashMap<String, Rc<str>>

Implementations

impl Localizer

pub fn add_from_path<P: AsRef<Path>>(&mut self, path: P)

Adds localization data from a directory. The path may be invalid, in which case the function will simply do nothing

pub fn add_localization_file(&mut self, contents: &str)

pub fn remove_formatting(&mut self)

Trait Implementations

impl Default for Localizer

fn default() -> Self

Returns the “default value” for a type.

impl Localize<Rc<str>> for Localizer

fn lookup<K: AsRef<str>>(&self, key: K) -> Option<Rc<str>>

A simple function that looks up raw value associated with the given localization key

fn is_empty(&self) -> bool

fn localize<K: AsRef<str>>(&self, key: K) -> Result<T, LocalizationError>

A simple localization function that will return the localized string. It assumes that the key is not complex and does not require any special handling.

fn localize_provider<K: AsRef<str>>( &self, key: K, provider: &str, value: &str, ) -> Result<T, LocalizationError>

A localization function that will return the localized string. It assumes a more complex key, resolving $provider$ into the value. More complex keys will not be resolved.

fn localize_query<K: AsRef<str>, S: AsRef<str>, F: Fn(&Vec<(String, Vec<String>)>) -> Option<S>>( &self, key: K, query: F, ) -> Result<T, LocalizationError>

A localization function that will return the localized string. It allows for complete control over the complex key resolution. Every time a $key$ or [function(arg)] is encountered, the query function will be called. The query function should return the value in accordance to the provided stack, or None if the value is not found. Whether None causes an error or not is up to the implementation.

impl Serialize for Localizer

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.