Struct EmbeddedCatalog 

pub struct EmbeddedCatalog { /* private fields */ }

An application’s Fluent catalogues, embedded with include_str! and loaded on first use on each thread.

Apps declare one static and route every string through it, so a --shots render, a unit test and a live session resolve the same copy with no build step or runtime file I/O:

static CATALOG: ui::i18n::EmbeddedCatalog = ui::i18n::EmbeddedCatalog::new(
    "en-US",
    &[("en-US", include_str!("../locales/en-US.ftl"))],
    "chat-mention-agent-tag",
);
pub fn t(key: &str) -> String { CATALOG.t(key) }

The manager is thread-local, so loading is per thread and idempotent. A host (the shell or the app runner) may already have installed a manager with the user’s locale; that one is never replaced — the catalogues are added to it. A fresh manager is installed only when the thread has none.

Implementations

impl EmbeddedCatalog

pub const fn new( source_locale: &'static str, catalogs: &'static [(&'static str, &'static str)], ) -> EmbeddedCatalog

Catalogues keyed by locale, one of which is source_locale.

A thread with no manager gets one selecting source_locale.

pub const fn as_shared(self) -> EmbeddedCatalog

The words ride along in the window’s language instead of deciding it: a catalogue every window shows (the toolkit’s widget labels, the Settings index) is written in languages the window itself may not speak, and must not make it speak them. See I18nManager::speaking_locale.

pub const fn with_language_pack(self, pack: LanguagePack) -> EmbeddedCatalog

Read the catalogue’s other languages from the language packs (LanguagePack) when it loads.

pub fn every_source(&self) -> Vec<(&'static str, Cow<'static, str>)>

Every language’s Fluent source, by tag: the embedded ones and those the installed language packs hold. For content that must be read in every language at once, such as the words search matches whatever language the desktop speaks.

pub fn languages(&self) -> Vec<&'static str>

The languages this catalogue can show, each once: the embedded ones and those with an installed pack, in the order the catalogue names them. A language installed under two tags (de and de-DE) is named by the one without a region, the pack’s.

pub fn source(&self) -> Option<&'static str>

The Fluent source of the source locale’s catalogue.

pub const fn sources(&self) -> &'static [(&'static str, &'static str)]

The embedded Fluent sources, by tag; Self::every_source adds the languages of the installed language packs.

pub const fn with_system_locale(self) -> EmbeddedCatalog

A thread with no manager gets one selecting the interface language from the person’s settings, the system locale as its default (see I18nManager::install_system).

pub const fn with_pinned_locale(self, locale: &'static str) -> EmbeddedCatalog

Select locale when this catalogue first loads into a thread’s manager, even over a host’s choice. For test builds that assert source copy on any developer or CI machine.

pub fn ensure(&self)

Load the catalogues on this thread if they are not loaded yet.

A key with no catalogue resolves to the key itself rather than panicking, so a missed call degrades to something legible — but it looks wrong, which is why string sites go through Self::t.

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

Resolve key in the active locale.

pub fn t_args(&self, key: &str, args: &[(&str, ArgValue)]) -> String

Resolve key, interpolating named variables.

The values are the app’s own words — a label, a participant’s name — so the sentence around them stays in the catalogue and only the nouns are substituted.

pub fn set_locale(&self, locale: &str)

Select locale (BCP-47 or POSIX, e.g. de_DE.UTF-8) on this thread. An unparseable value, C or POSIX selects the source locale.

pub fn current_locale(&self) -> String

The active locale’s BCP-47 tag on this thread.

Trait Implementations

impl Debug for EmbeddedCatalog

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

Formats the value using the given formatter.