icu_decimal 2.2.0

API for formatting basic decimal numbers in a locale-sensitive way
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).

//! Options for [`DecimalFormatter`](crate::DecimalFormatter).

/// A bag of options defining how numbers will be formatted by
/// [`DecimalFormatter`](crate::DecimalFormatter).
#[derive(Debug, Eq, PartialEq, Clone, Copy, Default, Hash)]
#[non_exhaustive]
pub struct DecimalFormatterOptions {
    /// When to render grouping separators.
    ///
    /// Default is [`GroupingStrategy::Auto`]
    pub grouping_strategy: Option<GroupingStrategy>,
}

impl From<GroupingStrategy> for DecimalFormatterOptions {
    fn from(grouping_strategy: GroupingStrategy) -> Self {
        Self {
            grouping_strategy: Some(grouping_strategy),
        }
    }
}

/// Configuration for how often to render grouping separators.
///
/// # Examples
///
/// ```
/// use icu::decimal::options;
/// use icu::decimal::DecimalFormatter;
/// use icu::locale::Locale;
/// use writeable::assert_writeable_eq;
///
/// let locale = Default::default();
/// let mut options: options::DecimalFormatterOptions = Default::default();
/// options.grouping_strategy = Some(options::GroupingStrategy::Min2);
/// let formatter = DecimalFormatter::try_new(locale, options)
///     .expect("locale should be present");
///
/// let one_thousand = 1000.into();
/// assert_writeable_eq!(formatter.format(&one_thousand), "1000");
///
/// let ten_thousand = 10000.into();
/// assert_writeable_eq!(formatter.format(&ten_thousand), "10,000");
/// ```
#[non_exhaustive]
#[derive(Debug, Eq, PartialEq, Clone, Copy, Hash, Default)]
pub enum GroupingStrategy {
    /// Render grouping separators according to locale preferences.
    #[default]
    Auto,

    /// Never render grouping separators.
    Never,

    /// Always render grouping separators.
    ///
    /// For [`DecimalFormatter`](crate::DecimalFormatter), [`GroupingStrategy::Always`]
    /// has the same behavior as [`GroupingStrategy::Auto`].
    Always,

    /// Render grouping separators only if there are at least 2 digits before the final grouping
    /// separator. In most locales, this means that numbers between 1000 and 9999 do not get
    /// grouping separators, but numbers 10,000 and above will.
    Min2,
}

/// A bag of options defining how numbers will be formatted by
/// [`CompactDecimalFormatter`](super::CompactDecimalFormatter).
///
/// <div class="stab unstable">
/// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. Do not use this type unless you are prepared for things to occasionally break.
///
/// Graduation tracking issue: [issue #7161](https://github.com/unicode-org/icu4x/issues/7161).
/// </div>
///
/// ✨ *Enabled with the `unstable` Cargo feature.*
#[cfg(feature = "unstable")]
#[derive(Debug, Eq, PartialEq, Clone)]
#[non_exhaustive]
pub struct CompactDecimalFormatterOptions {
    /// When to render grouping separators.
    ///
    /// Default is [`GroupingStrategy::Min2`]
    pub grouping_strategy: Option<GroupingStrategy>,
}

#[cfg(feature = "unstable")]
impl Default for CompactDecimalFormatterOptions {
    fn default() -> Self {
        GroupingStrategy::Min2.into()
    }
}

#[cfg(feature = "unstable")]
impl From<DecimalFormatterOptions> for CompactDecimalFormatterOptions {
    fn from(decimal_formatter_options: DecimalFormatterOptions) -> Self {
        Self {
            grouping_strategy: decimal_formatter_options.grouping_strategy,
        }
    }
}

#[cfg(feature = "unstable")]
impl From<CompactDecimalFormatterOptions> for DecimalFormatterOptions {
    fn from(decimal_formatter_options: CompactDecimalFormatterOptions) -> Self {
        Self {
            grouping_strategy: decimal_formatter_options.grouping_strategy,
        }
    }
}

#[cfg(feature = "unstable")]
impl From<GroupingStrategy> for CompactDecimalFormatterOptions {
    fn from(grouping_strategy: GroupingStrategy) -> Self {
        Self {
            grouping_strategy: Some(grouping_strategy),
        }
    }
}