Struct druid::LocalizedString

pub struct LocalizedString<T> { /* private fields */ }

A string that can be localized based on the current locale.

At its simplest, a LocalizedString is a key that can be resolved against a map of localized strings for a given locale.

Implementations

impl<T> LocalizedString<T>

pub const fn new(key: &'static str) -> Self

Create a new LocalizedString with the given key.

pub fn with_placeholder(self, placeholder: impl Into<ArcStr>) -> Self

Add a placeholder value. This will be used if localization fails.

This is intended for use during prototyping.

pub fn localized_str(&self) -> ArcStr

Return the localized value for this string, or the placeholder, if the localization is missing, or the key if there is no placeholder.

pub fn with_arg(
    self,
    key: &'static str,
    f: impl Fn(&T, &Env) -> FluentValue<'static> + 'static
) -> Self

Add a named argument and a corresponding closure. This closure is a function that will return a value for the given key from the current environment and data.

pub fn resolve(&mut self, data: &T, env: &Env) -> bool

Lazily compute the localized value for this string based on the provided environment and data.

Returns true if the current value of the string has changed.

Trait Implementations

impl<T: Clone> Clone for LocalizedString<T>

fn clone(&self) -> LocalizedString<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for LocalizedString<T>

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

Formats the value using the given formatter.

impl<T> From<LocalizedString<T>> for LabelText<T>

fn from(src: LocalizedString<T>) -> LabelText<T>

Converts to this type from the input type.