Struct UIString 

pub struct UIString(/* private fields */);

A concrete type that represents a string that can be displayed on screen.

Most widgets will accept an impl Into<UIString> parameter to receive the text that they should display.

Into<UIString> has been implemented for:

• &'static str, String, LocalizedString
• WeakVar<T> where T is:

&'static str, String, f32, f64, bool, char, usize, isize, u8, u16, u32, u64, u128, i8, i16, i32, i64, i128, NonZeroU8, NonZeroU16, NonZeroU32, NonZeroU64, NonZeroU128, NonZeroI8, NonZeroI16, NonZeroI32, NonZeroI64, or NonZeroI128.

Every type except &'static str and String will automatically update the screen when changed.

The ui_format macro can be used to create a UIString from a value using a custom format string.

Implementations

impl UIString

pub fn deferred<F>(f: F) -> Self

where F: for<'a> Fn(&'a TranslationMap) -> String + Send + Sync + 'static,

Creates a UIString that is computed later during UIString::resolve.

pub fn resolve<'a>( &'a self, translation_map: &'a TranslationMap, ) -> Option<UIStringRef<'a>>

Resolves the string to a type that derefs to &str.

This keeps the underlying lock active for the lifetime of the returned UIStringRef.

Trait Implementations

impl Clone for UIString

fn clone(&self) -> UIString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UIString

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

Formats the value using the given formatter.

impl From<&'static str> for UIString

fn from(value: &'static str) -> Self

Converts to this type from the input type.

impl From<LocalizedString> for UIString

fn from(value: LocalizedString) -> Self

Converts to this type from the input type.

impl From<String> for UIString

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<WeakVar<&'static str>> for UIString

fn from(value: WeakVar<&'static str>) -> Self

Converts to this type from the input type.

impl From<WeakVar<String>> for UIString

fn from(value: WeakVar<String>) -> Self

Converts to this type from the input type.

impl<T> From<WeakVar<T>> for UIString

where T: UIVarDisplay,

Any WeakVar<T> where T is in UIVarDisplay becomes a fast deferred formatter.

This does one heap alloc when constructing the UIString, and no heap alloc on resolve in the common case because SmallString stays inline for short strings.

fn from(var: WeakVar<T>) -> Self

Converts to this type from the input type.