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

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

/// Builder-style configuration for list formatting.
///
/// `humfmt` list formatting is intentionally minimal and predictable:
/// it joins slices into natural-language lists while respecting locale defaults,
/// with optional overrides.
///
/// # Examples
///
/// ```rust
/// use humfmt::ListOptions;
///
/// let opts = ListOptions::new()
///     .serial_comma_enabled(false)
///     .conjunction("plus");
///
/// assert_eq!(
///     humfmt::list_with(&["red", "green", "blue"], opts).to_string(),
///     "red, green plus blue"
/// );
/// ```
#[derive(Copy, Clone, Debug)]
pub struct ListOptions<L: Locale = English> {
    pub(crate) serial_comma: Option<bool>,
    pub(crate) conjunction: Option<&'static str>,
    pub(crate) locale: L,
}

impl ListOptions<English> {
    /// Creates default list formatting options (English).
    ///
    /// Defaults:
    /// - serial comma: locale default (English: enabled)
    /// - conjunction: locale default (English: `"and"`)
    /// - locale: `English`
    #[inline]
    pub fn new() -> Self {
        Self {
            serial_comma: None,
            conjunction: None,
            locale: English,
        }
    }
}

impl<L: Locale> Default for ListOptions<L> {
    #[inline]
    fn default() -> Self {
        Self {
            serial_comma: None,
            conjunction: None,
            locale: L::default(),
        }
    }
}

impl<L: Locale> ListOptions<L> {
    /// Enables the serial comma before the final list item.
    ///
    /// This is equivalent to `.serial_comma_enabled(true)`.
    #[inline]
    pub fn serial_comma(mut self) -> Self {
        self.serial_comma = Some(true);
        self
    }

    /// Configures serial-comma behavior with an explicit boolean.
    ///
    /// - `true`: `"a, b, and c"`
    /// - `false`: `"a, b and c"`
    #[inline]
    pub fn serial_comma_enabled(mut self, enabled: bool) -> Self {
        self.serial_comma = Some(enabled);
        self
    }

    /// Disables the serial comma before the final list item.
    ///
    /// This is equivalent to `.serial_comma_enabled(false)`.
    #[inline]
    pub fn no_serial_comma(mut self) -> Self {
        self.serial_comma = Some(false);
        self
    }

    /// Overrides the conjunction used to join the final list item.
    ///
    /// Example: `"plus"` produces `"a, b plus c"`.
    #[inline]
    pub fn conjunction(mut self, word: &'static str) -> Self {
        self.conjunction = Some(word);
        self
    }

    /// Switches the active locale for list formatting.
    ///
    /// Locale influences:
    /// - default conjunction (`and_word`)
    /// - default serial comma preference
    /// - list separator between items
    #[inline]
    pub fn locale<N: Locale>(self, locale: N) -> ListOptions<N> {
        ListOptions {
            serial_comma: self.serial_comma,
            conjunction: self.conjunction,
            locale,
        }
    }
}