Struct appstream::TranslatableList

pub struct TranslatableList(pub BTreeMap<String, Vec<String>>);

A wrapper around a list of strings that are translatable.

It's mostly used for the list of keywords a component can have

Example

use appstream::TranslatableList;
let keywords = TranslatableList::with_default(vec!["Color", "Contrast", "GNOME", "GTK"])
                        .and_locale("cs", vec!["barva", "kontrast"])
                        .and_locale("da", vec!["Farve", "Kontrast"]);

Implementations

impl TranslatableList

pub fn with_default(words: Vec<&str>) -> Self

Create a new TranslatableList using the default locale.

Arguments

• words - List of strings to add to the default locale.

pub fn and_locale(self, locale: &str, words: Vec<&str>) -> Self

Adds a list of strings for a specific locale.

Very useful when constructing a TranslatableList manually.

Arguments

• locale - The locale to use, use with_default if you want the default locale.
• words - The list of strings to add to this specific locale.

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 TranslatableList.

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

Adds a new string for a specific locale.

Arguments

• locale - The locale to use, C is used if None is provided.
• text - The string to add.

pub fn is_empty(&self) -> bool

Whether self contains any translatable strings.

Trait Implementations

impl Clone for TranslatableList

fn clone(&self) -> TranslatableList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TranslatableList

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

Formats the value using the given formatter.

impl Default for TranslatableList

fn default() -> TranslatableList

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for TranslatableList

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<TranslatableList> for TranslatableList

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

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

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

This method tests for !=.

impl Serialize for TranslatableList

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 TranslatableList