Struct perseus::internal::i18n::FsTranslationsManager

pub struct FsTranslationsManager { /* private fields */ }

The default translations manager. This will store static files in the specified location on disk. This should be suitable for nearly all development and serverful use-cases. Serverless is another matter though (more development needs to be done). This mandates that translations be stored as files named as the locale they describe (e.g. ‘en-US.ftl’, ‘en-US.json’, etc.).

As this is used as the default translations manager by most apps, this also supports not using i18n at all.

Implementations

impl FsTranslationsManager

pub async fn new(
    root_path: String,
    locales_to_cache: Vec<String>,
    file_ext: String
) -> Self

Creates a new filesystem translations manager. You should provide a path like /translations here. You should also provide the locales you want to cache, which will have their translations stored in memory. Any supported locales not specified here will not be cached, and must have their translations read from disk on every request. If fetching translations for any of the given locales fails, this will panic (locales to be cached should always be hardcoded).

Trait Implementations

impl Clone for FsTranslationsManager

fn clone(&self) -> FsTranslationsManager

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FsTranslationsManager

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

Formats the value using the given formatter.

impl TranslationsManager for FsTranslationsManager

fn new_dummy() -> Self

Creates a new instance of this translations manager, as a dummy for apps that aren’t using i18n at all. This may seem pointless, but it’s needed for trait completeness and to support certain engine middleware use-cases. In general, this should simply create an empty instance of the manager, and all other functions should do nothing if it is empty.

fn get_translations_str_for_locale<'life0, 'async_trait>(
    &'life0 self,
    locale: String
) -> Pin<Box<dyn Future<Output = Result<String, TranslationsManagerError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Gets the translations in string format for the given locale (avoids deserialize-then-serialize). If i18n is disabled, this should return a translator for the given locale with no translation string.

fn get_translator_for_locale<'life0, 'async_trait>(
    &'life0 self,
    locale: String
) -> Pin<Box<dyn Future<Output = Result<Translator, TranslationsManagerError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Gets a translator for the given locale. If i18n is disabled, this should return an empty string.