Struct vizia_core::localization::Localized

pub struct Localized { /* private fields */ }

A type which formats a localized message with any number of named arguments.

Implementations

impl Localized

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

Creates a new Localized type with a given key.

The given key is used to retrieve a translation from a fluent bundle resource.

Example

Application::new(|cx|{
    Label::new(cx, Localized::new("key"));
})
.run();

pub fn map(self, mapping: impl Fn(&str) -> String + 'static) -> Self

Sets a mapping function to apply to the translated text.

pub fn arg<L>(self, key: &str, lens: L) -> Self

where L: Lens<Target: Into<FluentValue<'static>> + Data>,

Add a variable argument binding to the Localized type.

Takes a key name and a lens to the value for the argument.

Example

Application::new(|cx|{
     
    AppData {
        value: 5,
    }.build(cx);

    Label::new(cx, Localized::new("key").arg("value", AppData::value));
})
.run();

pub fn arg_const<T: Into<FluentValue<'static>> + Data>( self, key: &str, val: T, ) -> Self

Add a constant argument to the Localized type.

Takes a key name and a value for the argument.

Example

Application::new(|cx|{

    Label::new(cx, Localized::new("key").arg_const("value", 32));
})
.run();

Trait Implementations

impl Clone for Localized

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Data for Localized

fn same(&self, other: &Self) -> bool

impl PartialEq for Localized

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Res<String> for Localized

fn set_or_bind<F>(self, cx: &mut Context, entity: Entity, closure: F)

where F: 'static + Clone + Fn(&mut Context, Localized),

impl ResGet<String> for Localized

fn get_ref<'a>( &'a self, cx: &'a impl DataContext, ) -> Option<LensValue<'a, String>>

fn get(&self, cx: &impl DataContext) -> String

impl ToStringLocalized for Localized

fn to_string_local(&self, cx: &impl DataContext) -> String