xapi-data 1.0.0-rc.1

Rust bindings for the Experience API (xAPI) data structures
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// SPDX-License-Identifier: GPL-3.0-or-later

use crate::{DataError, MyLanguageTag};

/// xAPI refers to a [Language Map][1] as a dictionary of words or sentences
/// keyed by the [RFC 5646:][2] "Tags for Identifying Languages".
///
/// This trait exposes a way for populating such dictionaries.
///
/// Note though that the recommended way for populating a _Language Map_ is
/// through the [add_language][crate::add_language] macro.
///
/// [1]: [crate::LanguageMap]
/// [2]: https://datatracker.ietf.org/doc/rfc5646/
pub trait MultiLingual {
    /// A _Builder_ style method to add to, and if successful return, `self` (a
    /// [LanguageMap][1]) a `label` string in a given language `tag`.
    ///
    /// Raise [DataError] if an error occurs in the process.
    ///
    /// [1]: [crate::LanguageMap]
    fn add_label(&mut self, tag: &MyLanguageTag, label: &str) -> Result<&mut Self, DataError>;
}