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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

#![warn(missing_docs)]
#![warn(rustdoc::missing_doc_code_examples)]
#![doc = include_str!("../README.md")]

pub mod format;
pub mod languages;

use crate::format::Format;
use crate::languages::Language::*;

/// Return cardinal number name for a given number with the default format
///
/// Example:
/// ```rust
/// assert_eq!(number_names::cardinal(10), "ten".to_string())
/// ```
pub fn cardinal(num: u64) -> String {
    cardinal_with_fmt(num, Format::default())
}

/// Return cardinal number name for a given number with a given format
///
/// Example:
/// ```rust
/// use number_names::{cardinal_with_fmt, Format};
///
/// assert_eq(cardinal_with_fmt(20, Format::default()), "twenty".to_string());
/// ```
pub fn cardinal_with_fmt(num: u64, fmt: Format) -> String {
    match fmt.language {
        EnUs => crate::languages::en_us::cardinal_with_format(num, fmt),
        _ => crate::languages::en_us::cardinal_with_format(num, fmt),
    }
}

/// Return ordinal number name for a given number with the default format
///
/// Example:
/// ```rust
/// assert_eq!(number_names::ordinal(10), "tenth".to_string())
/// ```
pub fn ordinal(num: u64) -> String {
    ordinal_with_fmt(num, Format::default())
}

/// Return ordinal number name for a given number with a given format
///
/// Example:
/// ```rust
/// use number_names::{ordinal_with_fmt, Format};
///
/// assert_eq(ordinal_with_fmt(20, Format::default()), "twentieth".to_string());
/// ```
pub fn ordinal_with_fmt(num: u64, fmt: Format) -> String {
    match fmt.language {
        EnUs => crate::languages::en_us::ordinal_with_format(num, fmt),
        _ => crate::languages::en_us::ordinal_with_format(num, fmt),
    }
}

mod tests;