re_format 0.32.0-alpha.1

Miscellaneous tools to format and parse numbers, durations, etc.
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

use std::fmt::Display;

use re_log::debug_assert;

use crate::{UnsignedAbs, format_int, format_uint};

/// Returns either "1 $NOUN" (if `count` is one), otherwise returns `$N $NOUNs`.
pub fn format_plural_s(count: impl num_traits::Unsigned + Display, noun: &'static str) -> String {
    debug_assert!(!noun.ends_with('s'), "Expected singular, got {noun:?}");

    if count.is_one() {
        format!("1 {noun}")
    } else {
        format!("{} {noun}s", format_uint(count))
    }
}

/// Like [`format_plural_s`], but also handles `-1` as singular.
pub fn format_plural_signed_s<Int>(count: Int, noun: &'static str) -> String
where
    Int: num_traits::Signed + Display + PartialOrd + num_traits::Zero + UnsignedAbs,
    Int::Unsigned: Display + num_traits::Unsigned,
{
    debug_assert!(!noun.ends_with('s'), "Expected singular, got {noun:?}");

    if count.abs().is_one() {
        format!("{} {noun}", format_int(count))
    } else {
        format!("{} {noun}s", format_int(count))
    }
}

#[test]
fn test_format_plural_s() {
    assert_eq!(format_plural_s(0_usize, "item"), "0 items");
    assert_eq!(format_plural_s(1_usize, "item"), "1 item");
    assert_eq!(format_plural_s(2_usize, "item"), "2 items");
    assert_eq!(format_plural_s(100_usize, "component"), "100 components");
}

#[test]
fn test_format_plural_signed_s() {
    let minus = crate::MINUS;
    assert_eq!(format_plural_signed_s(0_isize, "frame"), "0 frames");
    assert_eq!(format_plural_signed_s(1_isize, "frame"), "1 frame");
    assert_eq!(
        format_plural_signed_s(-1_isize, "frame"),
        format!("{minus}1 frame")
    );
    assert_eq!(format_plural_signed_s(2_isize, "frame"), "2 frames");
    assert_eq!(
        format_plural_signed_s(-2_isize, "frame"),
        format!("{minus}2 frames")
    );
    assert_eq!(
        format_plural_signed_s(-100_isize, "offset"),
        format!("{minus}100 offsets")
    );
}