Struct xvii::Roman

pub struct Roman(_);

A Roman numeral.

This struct stores the value of a numeral as an NonZeroU16 but provides for Roman-style formatting.

Implementations

impl Roman

pub fn new(n: u16) -> Result<Roman>

Creates a Roman value based on a u16.

This function will return None if the value supplied is outside the acceptable range of 1..=4999, because numbers outside that range cannot be appropriately formatted using the seven standard numerals.

pub fn to_uppercase(self) -> String

Formats a Roman value as an uppercase Roman numeral.

Examples

use xvii::Roman;
assert_eq!(Roman::new(42).unwrap().to_uppercase(), "XLII");

pub fn to_lowercase(self) -> String

Formats a Roman value as a lowercase Roman numeral.

Examples

use xvii::Roman;
assert_eq!(Roman::new(42).unwrap().to_lowercase(), "xlii");

pub const fn format(&self, style: Style) -> RomanFormatter

Returns a RomanFormatter which lazily formats a self value as a lowercase or uppercase Roman numeral depending of style.

Examples

use xvii::{Roman, Style};

let value = Roman::new(12).unwrap();
assert_eq!(format!("{}", value.format(Style::Upper)), "XII");
assert_eq!(value.format(Style::Lower).to_string(), "xii"); // `format!("{}")` and `.to_string()` are the same thing

pub const fn value(self) -> u16

Returns value of this Roman numeral.

Examples

let roman = xvii::Roman::new(42).unwrap();
assert_eq!(roman.value(), 42);

pub const fn into_inner(self) -> NonZeroU16

Returns the inner value.

Examples

let roman = xvii::Roman::new(42).unwrap();
assert_eq!(roman.into_inner(), std::num::NonZeroU16::new(42).unwrap());

Trait Implementations

impl Clone for Roman

fn clone(&self) -> Roman

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Roman

impl Debug for Roman

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Roman

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Roman

impl FromStr for Roman

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for Roman

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Roman

fn cmp(&self, other: &Roman) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Roman> for Roman

fn eq(&self, other: &Roman) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Roman) -> bool

This method tests for !=.

impl PartialOrd<Roman> for Roman

fn partial_cmp(&self, other: &Roman) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Roman) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Roman) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Roman) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Roman) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Roman

impl StructuralPartialEq for Roman