Struct MultiLoader

pub struct MultiLoader { /* private fields */ }

A loader comprised of other loaders.

This loader allows for loaders with multiple sources to be used from a single one, instead of a multiple of them.

The idea behind this loader is to allow for the scenario where you depend on crates that have their own loader (think of protocol crates which are dependencies of a frontend -> the frontend needs to know each of the protocol’s messages and be able to display them). Using a multiloader allows you to query multiple localization sources from one single source.

Note that a [M̀ultiloader] is most useful where each of your fluent modules is specially namespaced to avoid name collisions.

Usage

use fluent_templates::{ArcLoader, StaticLoader, MultiLoader, Loader};
use unic_langid::{LanguageIdentifier, langid};

const US_ENGLISH: LanguageIdentifier = langid!("en-US");
const CHINESE: LanguageIdentifier = langid!("zh-CN");

fluent_templates::static_loader! {
    static LOCALES = {
        locales: "./tests/locales",
        fallback_language: "en-US",
        // Removes unicode isolating marks around arguments, you typically
        // should only set to false when testing.
        customise: |bundle| bundle.set_use_isolating(false),
    };
}

fn main() {
    let cn_loader = ArcLoader::builder("./tests/locales", CHINESE)
        .customize(|bundle| bundle.set_use_isolating(false))
        .build()
        .unwrap();

    let mut multiloader = MultiLoader::from_iter([
        Box::new(&*LOCALES) as Box<dyn Loader>,
    ]);
    multiloader.push_back(Box::new(cn_loader) as Box<dyn Loader>);
    assert_eq!("Hello World!", multiloader.lookup(&US_ENGLISH, "hello-world"));
    assert_eq!("儿", multiloader.lookup(&CHINESE, "exists"));
}

Order of search

The one that is inserted first is also the one searched first.

Implementations

impl MultiLoader

pub fn new() -> Self

Creates a MultiLoader without any loaders.

pub fn from_iter(iter: impl IntoIterator<Item = Box<dyn Loader>>) -> Self

Creates a MultiLoader from an iterator of loaders.

pub fn push_front(&mut self, loader: Box<dyn Loader>)

Pushes a loader in front of all the others in terms of precedence.

pub fn push_back(&mut self, loader: Box<dyn Loader>)

Pushes a loader at the back in terms of precedence.

pub fn remove(&mut self, idx: usize) -> Option<Box<dyn Loader>>

Pushes a loader at the back in terms of precedence.

Trait Implementations

impl Default for MultiLoader

fn default() -> Self

Returns the “default value” for a type.

impl Loader for MultiLoader

fn lookup_complete( &self, lang: &LanguageIdentifier, text_id: &str, args: Option<&HashMap<Cow<'static, str>, FluentValue<'_>>>, ) -> String

Look up text_id for lang in Fluent, using any args if provided.

fn try_lookup_complete( &self, lang: &LanguageIdentifier, text_id: &str, args: Option<&HashMap<Cow<'static, str>, FluentValue<'_>>>, ) -> Option<String>

Look up text_id for lang in Fluent, using any args if provided.

fn locales(&self) -> Box<dyn Iterator<Item = &LanguageIdentifier> + '_>

Returns an Iterator over the locales that are present.

fn lookup(&self, lang: &LanguageIdentifier, text_id: &str) -> String

Look up text_id for lang in Fluent.

fn lookup_with_args( &self, lang: &LanguageIdentifier, text_id: &str, args: &HashMap<Cow<'static, str>, FluentValue<'_>>, ) -> String

Look up text_id for lang with args in Fluent.

fn try_lookup(&self, lang: &LanguageIdentifier, text_id: &str) -> Option<String>

Look up text_id for lang in Fluent.

fn try_lookup_with_args( &self, lang: &LanguageIdentifier, text_id: &str, args: &HashMap<Cow<'static, str>, FluentValue<'_>>, ) -> Option<String>

Look up text_id for lang with args in Fluent.