Struct Strings 

pub struct Strings { /* private fields */ }

The catalogue a host installs, and the one components read.

It holds only the entries a host replaced. An absent entry is not a gap to be filled at runtime; it means the English default stands, which is why a partial catalogue is a legitimate thing to install rather than a mistake.

Implementations

impl Strings

pub fn new() -> Self

An empty catalogue: every key answers with its English.

pub fn set( &mut self, key: StringKey, text: impl Into<SharedString>, ) -> &mut Self

Replaces one entry.

pub fn clear(&mut self, key: StringKey) -> &mut Self

Restores the English for one entry.

pub fn clear_all(&mut self) -> &mut Self

Restores the English for every entry.

pub fn extend( &mut self, entries: impl IntoIterator<Item = (StringKey, SharedString)>, ) -> &mut Self

Replaces many entries, leaving the rest alone.

pub fn is_overridden(&self, key: StringKey) -> bool

Whether this key was replaced. A component never asks; a test does.

pub fn text(&self, key: StringKey) -> SharedString

The text behind a key, which is always something a reader can read.

pub fn format(&self, key: StringKey, args: &[&str]) -> SharedString

The text behind a key with {0}, {1}, … replaced in place.

A placeholder with no argument is left standing rather than removed, so a wrong translation reads as an obvious mistake instead of a sentence that quietly lost a fact.

Trait Implementations

impl Clone for Strings

fn clone(&self) -> Strings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Strings

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

Formats the value using the given formatter.

impl Default for Strings

fn default() -> Strings

Returns the “default value” for a type.

impl Global for Strings