number_names/format.rs
1//! Defines configuration struct Format to control number name formatting.
2use crate::languages::Language;
3use crate::languages::Language::EnUs;
4
5///
6/// Configuration struct to control formatting of the number names.
7/// Currently used only to specify the language.
8///
9/// Examples:
10///
11/// ```rust
12/// // default format
13/// let fmt = number_names::Format::default();
14///
15/// // specify a language
16/// let fmt = number_names::Format(number_names::languages::Language::EnUs);
17/// ```
18pub struct Format {
19 /// Language the number name should be formatted in
20 pub language: Language,
21}
22
23impl Format {
24 /// Return a Format with the default values
25 /// (currently only language set to American English)
26 ///
27 /// Example:
28 /// ```rust
29 /// let fmt = number_names::Format::default();
30 /// assert_eq!(fmt, number_names::Format{number_names::languages::Language::EnUs});
31 /// ```
32 pub fn default() -> Format {
33 Format { language: EnUs }
34 }
35}