Struct LanguageMap

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

A dictionary where the key is an RFC 5646 Language Tag, and the value is a string in the language indicated by the tag. This map is supposed to be populated as fully as possible.

IMPLEMENTATION NOTE - This implementation uses a B-Tree based natural language ordered map (BTreeMap), in preference to a HashMap b/c it seems to be faster when deserializing, as well easier when finding correct candidate for a langauge-tag w/ a country variant; for example deciding on the appropriate label when the dictionary contains entries for en-US, en, and en-AU.

Requirements for Canonical format

xAPI requirements for producing resources that have a LanguageMap property when canonical format is specified state:

• Activity objects —more specifically their ActivityDefinition parts— contain LanguageMap objects within their name, description and various InteractionComponents. The LRS shall return only one language in each of these maps.
• The LRS may maintain canonical versions of language maps against any IRI identifying an object containing language maps. This includes the language map stored in the Verb’s display property and potentially some language maps used within extensions.
• The LRS may maintain a canonical version of any language map and return this when canonical format is used to retrieve Statements. The LRS shall return only one language within each language map for which it returns a canonical map.
• In order to choose the most relevant language, the LRS shall apply the Accept-Language header as described in RFC-2616, except that this logic shall be applied to each language map individually to select which language entry to include, rather than to the resource (list of Statements) as a whole.

Implementations

impl LanguageMap

pub fn new() -> Self

Create an empty LanguageMap instance.

pub fn len(&self) -> usize

Return the number of entries in this dictionary.

pub fn get(&self, k: &MyLanguageTag) -> Option<&str>

Return a reference to the label keyed by k if it exists, or None otherwise.

pub fn is_empty(&self) -> bool

Return TRUE if this dictionary is empty; FALSE otherwise.

pub fn append(&mut self, other: &mut Self)

Move all elements from other into self, leaving other empty.

pub fn insert(&mut self, k: &MyLanguageTag, v: &str) -> Option<String>

Insert v keyed by k and return the previous v if k was already known, or None otherwise.

pub fn keys(&self) -> Keys<'_, MyLanguageTag, String>

Return an iterator over this dictionary’s keys.

pub fn contains_key(&self, k: &MyLanguageTag) -> bool

Return TRUE if k is a known key of this dictionary; FALSE otherwise.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&MyLanguageTag, &mut String) -> bool,

Retain entries in this that satisfy the given predicate.

pub fn extend(&mut self, other: Self)

Extend this w/ the contents of other without modifying the latter.

Trait Implementations

impl Canonical for LanguageMap

fn canonicalize(&mut self, tags: &[MyLanguageTag])

Reduce self to conform to its canonical format as defined in xAPI keeping the most appropriate entry given a list of preferred language tags.

impl Clone for LanguageMap

fn clone(&self) -> LanguageMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LanguageMap

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

Formats the value using the given formatter.

impl Default for LanguageMap

fn default() -> LanguageMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LanguageMap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LanguageMap

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

Formats the value using the given formatter.

impl MultiLingual for LanguageMap

fn add_label( &mut self, tag: &MyLanguageTag, label: &str, ) -> Result<&mut Self, DataError>

A Builder style method to add to, and if successful return, self (a LanguageMap) a label string in a given language tag.

impl PartialEq for LanguageMap

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

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

const 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 Serialize for LanguageMap

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LanguageMap

impl StructuralPartialEq for LanguageMap