Struct AppI18n 

pub struct AppI18n { /* private fields */ }

One app’s own translator, formatter and locale switch, held in its world.

The hooks above are process-wide, which is what a script host needs and all it can reach. Markup is spawned from a world, so it reads this instead: a process hosting two Lumen apps renders each app’s text in its own locale, and switching one app’s locale leaves the other where it was.

The handles are the same opaque ones. Core forwards a key, or a spec and a value, or a locale tag, and returns what came back; the locale side of the seam is what the runtime installs here.

Implementations

impl AppI18n

pub fn new( translator: Translator, formatter: Formatter, set_locale: LocaleSetter, ) -> Self

Pair a translator, a formatter and a locale switch for one app.

pub fn try_translate(&self, key: &str) -> Option<String>

Resolve key against this app’s catalogue, or None on a miss.

pub fn format(&self, spec: &str, value: &str) -> Option<String>

Format value per spec for this app’s locale, or None when the spec is not one it knows or the value is not what that spec expects. A caller shows value unchanged then.

pub fn set_locale(&self, tag: &str) -> Option<LocaleChange>

Switch this app to tag, answering with the locale it is now in and the writing direction to read it in. None means tag is not a locale tag and nothing changed.

Reach this through a ResMut<AppI18n> borrow: the systems that rebuild an app’s text wake on the resource being marked changed.

Trait Implementations

impl Clone for AppI18n

fn clone(&self) -> AppI18n

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for AppI18n

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Resource for AppI18n

where Self: Send + Sync + 'static,