number-names 0.2.0

Number names is a Rust library to provide formatted string names for cardinal and ordinal numbers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! Defines configuration struct Format to control number name formatting.
use crate::languages::Language;
use crate::languages::Language::EnUs;

///
/// Configuration struct to control formatting of the number names.
/// Currently used only to specify the language.
///
/// Examples:
///
/// ```rust
/// // default format
/// let fmt = number_names::Format::default();
///
/// // specify a language
/// let fmt = number_names::Format(number_names::languages::Language::EnUs);
/// ```
pub struct Format {
    /// Language the number name should be formatted in
    pub language: Language,
}

impl Format {
    /// Return a Format with the default values
    /// (currently only language set to American English)
    ///
    /// Example:
    /// ```rust
    /// let fmt = number_names::Format::default();
    /// assert_eq!(fmt, number_names::Format{number_names::languages::Language::EnUs});
    /// ```
    pub fn default() -> Format {
        Format { language: EnUs }
    }
}