Struct poem::i18n::I18NResourcesBuilder

pub struct I18NResourcesBuilder { /* private fields */ }

This is supported on crate feature i18n only.

I18N resources builder.

Implementations

impl I18NResourcesBuilder

pub fn add_path(self, path: impl Into<PathBuf>) -> Self

Add resources directory.

The resource directory contains multiple language directories, each of which can contain multiple FTL files for that language.

/resources
    /en-US
        simple.ftl
        errors.ftl
    /zh-CN
        simple.ftl
        errors.ftl

pub fn add_ftl(
    self,
    language: impl Into<String>,
    ftl: impl Into<String>
) -> Self

Add FTL(Fluent Translation List) for the specified language.

Example

use poem::i18n::I18NResources;

let resources = I18NResources::builder()
    .add_ftl("en-US", "hello-world = Hello world!")
    .add_ftl("zh-CN", "hello-world = 你好世界！")
    .build()
    .unwrap();

pub fn default_language(self, language: LanguageIdentifier) -> Self

Set the default language when the language negotiation fails.

NOTE: This language ID matches exactly the language id contained in the resources.

Example

use poem::i18n::I18NResources;
use unic_langid::langid;

let resources = I18NResources::builder()
    .add_ftl("en-US", "hello-world = Hello world!")
    .add_ftl("zh-CN", "hello-world = 你好世界！")
    .default_language(langid!("en-US"))
    .build()
    .unwrap();

pub fn negotiation_strategy(self, strategy: NegotiationStrategy) -> Self

Sets the negotiation strategy.

Default is NegotiationStrategy::Filtering.

pub fn build(self) -> Result<I18NResources, I18NError>

Consumes this builder and returns a I18NResources object.