Struct appstream::MarkupTranslatableString

pub struct MarkupTranslatableString(pub BTreeMap<String, String>);

A wrapper around a translable string that can contains markup.

Example

use appstream::MarkupTranslatableString;
let description = MarkupTranslatableString::with_default("<p>Contrast checks whether the contrast between two colors meet the WCAG requirements.</p>")
                .and_locale("cs", "<p>Kontroluje kontrast mezi dvěma zadanými barvami, jestli vyhovuje požadavkům pravidel pro bezbariérové weby (WCAG).</p>")
                .and_locale("es", "<p>Contraste comprueba la diferencia de contraste entre dos colores que cumplen los requisitos WCAG.</p>");

Implementations

impl MarkupTranslatableString

pub fn with_default(text: &str) -> Self

Create a new MarkupTranslatableString using the default locale.

Arguments

• text - The string that corresponds to the default locale.

pub fn and_locale(self, locale: &str, text: &str) -> Self

Adds a new translation for a specific locale.

Very useful when constructing a TranslatableString manually.

Arguments

• locale - The locale to use, use with_default if you want the default locale.
• text - The corresponding translation.

pub fn add_for_element(&mut self, element: &Element)

Adds a new string from a xmltree.Element

XML elements containing a lang attribute are marked as translatable and can be used to feed the MarkupTranslatableString.

pub fn add_for_locale(&mut self, locale: Option<&str>, text: &str)

Adds a new translation for a speicifc locale.

Arguments

• locale - The locale to use, the default locale is used if None is set instead.
• text - The translation corresponding to the locale.

pub fn get_default(&self) -> Option<&String>

Returns the text corresponding to the default locale C.

pub fn get_for_locale(&self, locale: &str) -> Option<&String>

Retrieve the corresponding text for a specific locale if available.

Arguments

• locale - The locale to retrieve the text for.

pub fn is_empty(&self) -> bool

Whether self contains any translatable strings.

Trait Implementations

impl Clone for MarkupTranslatableString

fn clone(&self) -> MarkupTranslatableString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MarkupTranslatableString

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

Formats the value using the given formatter.

impl Default for MarkupTranslatableString

fn default() -> MarkupTranslatableString

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for MarkupTranslatableString

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<MarkupTranslatableString> for MarkupTranslatableString

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for MarkupTranslatableString

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MarkupTranslatableString