humfmt 0.5.0

Ergonomic human-readable formatting toolkit for Rust
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use crate::locale::{English, Locale};

/// Builder-style configuration for percentage formatting.
///
/// # Examples
///
/// ```rust
/// use humfmt::PercentOptions;
///
/// let opts = PercentOptions::new().precision(2);
/// assert_eq!(humfmt::percent_with(0.4236, opts).to_string(), "42.36%");
/// ```
#[derive(Copy, Clone, Debug)]
pub struct PercentOptions<L: Locale = English> {
    pub(crate) precision: u8,
    pub(crate) force_sign: bool,
    pub(crate) fixed_precision: bool,
    pub(crate) locale: L,
}

impl PercentOptions<English> {
    /// Creates default percentage formatting options.
    ///
    /// Defaults:
    /// - precision: `1`
    /// - force sign: `false`
    /// - fixed precision: `false` (trailing zeros are trimmed)
    /// - locale: `English`
    #[inline]
    pub fn new() -> Self {
        Self {
            precision: 1,
            force_sign: false,
            fixed_precision: false,
            locale: English,
        }
    }
}

impl<L: Locale> Default for PercentOptions<L> {
    #[inline]
    fn default() -> Self {
        Self {
            precision: 1,
            force_sign: false,
            fixed_precision: false,
            locale: L::default(),
        }
    }
}

impl<L: Locale> PercentOptions<L> {
    /// Sets decimal precision for the percentage value.
    ///
    /// Precision is clamped to `0..=6`.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use humfmt::PercentOptions;
    ///
    /// let opts = PercentOptions::new().precision(2);
    /// assert_eq!(humfmt::percent_with(0.4236, opts).to_string(), "42.36%");
    /// ```
    #[inline]
    pub fn precision(mut self, n: u8) -> Self {
        self.precision = n.min(6);
        self
    }

    /// Forces the output of a `+` sign for strictly positive values.
    ///
    /// Values that round to exactly zero will output `0%` without a sign.
    /// Useful for deltas and change indicators.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use humfmt::PercentOptions;
    ///
    /// let opts = PercentOptions::new().force_sign(true);
    /// assert_eq!(humfmt::percent_with(0.42, opts).to_string(), "+42%");
    /// assert_eq!(humfmt::percent_with(-0.42, opts).to_string(), "-42%");
    /// assert_eq!(humfmt::percent_with(0.0, opts).to_string(), "0%");
    /// ```
    #[inline]
    pub fn force_sign(mut self, yes: bool) -> Self {
        self.force_sign = yes;
        self
    }

    /// Controls whether trailing fractional zeros are preserved.
    ///
    /// - `false` (default): trailing zeros are trimmed — `42.50%` becomes `42.5%`
    /// - `true`: trailing zeros are kept — `42.50%` stays `42.50%`
    ///
    /// Useful for consistent column widths in tables or dashboards.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use humfmt::PercentOptions;
    ///
    /// let trimmed = PercentOptions::new().precision(2);
    /// assert_eq!(humfmt::percent_with(0.425, trimmed).to_string(), "42.5%");
    ///
    /// let fixed = PercentOptions::new().precision(2).fixed_precision(true);
    /// assert_eq!(humfmt::percent_with(0.425, fixed).to_string(), "42.50%");
    /// ```
    #[inline]
    pub fn fixed_precision(mut self, yes: bool) -> Self {
        self.fixed_precision = yes;
        self
    }

    /// Switches the active locale.
    ///
    /// Affects the decimal separator used in the output.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use humfmt::{percent_with, PercentOptions};
    /// use humfmt::locale::CustomLocale;
    ///
    /// let locale = CustomLocale::english().decimal_separator(',');
    /// let opts = PercentOptions::new().precision(1).locale(locale);
    /// assert_eq!(percent_with(0.423, opts).to_string(), "42,3%");
    /// ```
    #[inline]
    pub fn locale<N: Locale>(self, locale: N) -> PercentOptions<N> {
        PercentOptions {
            precision: self.precision,
            force_sign: self.force_sign,
            fixed_precision: self.fixed_precision,
            locale,
        }
    }
}