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

//! # XVII

//!

//! ...Pronounced any way you like--including "seventeen."

//!

//! This library provides parsing and formatting for Roman numerals. According to my

//! (probably extremely suspect) benchmarks, this is the best-performing library of

//! its kind available on crates.io (you know, as of St. Patrick's Day, 2017 when I

//! did the tests), so you should definitely employ it in your high-availability NAAS

//! (numerals-as-a-service) project.

//!

//! (Seriously, though, read the license--no warranties implied!)

//!

//! ```rust

//! # use xvii::Roman;

//! let seventeen: Roman = "XVII".parse().unwrap();

//! assert_eq!(17, seventeen.value());

//! assert_eq!("XVII", seventeen.to_string());

//!

//! let seventeen = Roman::new(17).unwrap();

//! assert_eq!(17, seventeen.value());

//! assert_eq!("XVII", seventeen.to_string());

//! ```

//!

//! # `no_std` support

//!

//! `no_std` mode is supported if crate is built without `std` feature (enabled by default).

//! I.e. you need to turn off default features to build `xvii` without std:

//!

//! ```toml

//! xvii = { version = "...", default-features = false }

//! ```

#![cfg_attr(not(any(feature = "std", test)), no_std)]
// To build docs properly, run

// `RUSTFLAGS="--cfg docsrs" cargo +nightly doc --all-features`

#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(
    broken_intra_doc_links,
    missing_debug_implementations,
    missing_docs,
    unsafe_code
)]

mod error;
mod roman;
mod unit;

pub use error::Error;
pub use roman::{Roman, RomanFormatter, Style};

/// [`Result`](std::result::Result) with error defaulted to [`xvii::Error`](Error)

pub type Result<T, E = Error> = core::result::Result<T, E>;