3 releases
0.1.2 | Jan 25, 2024 |
---|---|
0.1.1 | Sep 26, 2022 |
0.1.0 | Apr 10, 2022 |
#118 in Value formatting
56 downloads per month
12KB
116 lines
Romantic 🏛
Roman numeral library for Rust.
API
For full documentation see docs.rs.
Examples
Using the default Roman numeral system.
use romantic::Roman;
let roman = Roman::default();
assert_eq!(roman.to_string(2022).unwrap(), "MMXXII");
assert_eq!(roman.from_str::<i32>("MMXXII").unwrap(), 2022);
// The default Roman numeral system has a maximum of 3999.
assert!(roman.to_string(4000).is_err());
Using your own custom character set.
use romantic::Roman;
// The order of characters in the array determines their value.
// Here, A equals 1 and B equals 5.
let custom = Roman::new(&['A', 'B']);
assert_eq!(custom.to_string(6).unwrap(), "BA");
assert_eq!(custom.from_str::<i32>("BA").unwrap(), 6);
// With only 2 characters, the maximum value you can get is 8
// (the equivalent of VIII). To increase the maximum range, use
// more characters.
assert!(custom.to_string(9).is_err());
Development
With Nix flakes and direnv installed and enabled, all the required dependencies are automatically loaded from shell.nix
. Then cargo-make can be used to build, deploy and lint the code. The available tasks are all described in the Makefile.toml
configuration.
Feedback
Found a problem or want to request a new feature? Email helllo@holllo.org and I'll see what I can do for you.
License
Distributed under the Apache License 2.0 and MIT licenses, see LICENSE-Apache and LICENSE-MIT for more information.
Dependencies
~0.6–1.2MB
~26K SLoC