#ordinal #numbers

no-std ordinal-trait

Format numbers as ordinals efficiently

1 unstable release

0.1.0 Nov 5, 2024

#97 in Value formatting

Download history 166/week @ 2024-11-02 127/week @ 2024-11-09 53/week @ 2024-11-16

346 downloads per month

MIT license

13KB
213 lines

Ordinal formatting

Format numbers as ordinals efficiently. You can get the ordinal suffix e.g., "st", "nd", "rd", or "th" without allocations.

Examples

Format a number as an ordinal, allocating a new String:

use ordinal_trait::Ordinal as _;
assert_eq!(12.to_ordinal(), "12th");

Get a number representing an ordinal you can use with comparisons and formatting.

use ordinal_trait::Ordinal as _;
let n = 12.to_number();
assert_eq!(*n, 12);
assert_eq!(format!("{n}"), "12th");

Performance

Compared to most other implementations that allocate a string just to check the last one or two characters, this implementation is much faster and does not allocate a string[^1].

violin plot

To compare measurements across branches:

git checkout main
cargo bench -- --save-baseline main

git checkout feature
cargo bench -- --baseline main

[^1]: Criterion does not have built-in memory profiling but when I find an impl of Measurement to do so - or find time to write one - I'll include those stats as well; however, take into consideration that this implementation does not allocate a string at all for suffix().

No runtime deps