Struct septem::Roman

pub struct Roman(_);

A Roman number

Stores the value internally a u32

Implementations

impl Roman

pub fn from<T: Into<u32>>(val: T) -> Result<Self>

Creates a Roman numeral for any value that implements Into<u32>. Requires value to be greater than 0, and less than 4000.

Examples

let sept: Roman = Roman::from(7u32).unwrap();
assert_eq!("VII", sept.to_string());

Returns Roman , or an `septem::Error

pub fn from_unchecked<T: Into<u32>>(val: T) -> Self

Creates a Roman numeral for any value that implements Into<u32>. Does not to any range checking, so can result in weird numerals.

Examples

let sept: Roman = Roman::from_unchecked(5032u32);
assert_eq!("MMMMMXXXII", sept.to_string());

Returns Roman

pub fn to_lowercase(self) -> String

Returns lowercase string representation of the Roman numeral

pub fn to_uppercase(self) -> String

Returns uppercase string representation of the Roman numeral

pub fn to_digits(self) -> Vec<Digit>

Returns vector of digits representing the roman numeral

Methods from Deref<Target = u32>

pub const MIN: u32

pub const MAX: u32

pub const BITS: u32

pub fn as_ne_bytes(&self) -> &[u8; 4]

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

Return the memory representation of this integer as a byte array in native byte order.

to_ne_bytes should be preferred over this whenever possible.

Examples

#![feature(num_as_ne_bytes)]
let num = 0x12345678u32;
let bytes = num.as_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        &[0x12, 0x34, 0x56, 0x78]
    } else {
        &[0x78, 0x56, 0x34, 0x12]
    }
);

Trait Implementations

impl AsRef<u32> for Roman

Support dereferencing to u32

Examples

let sept: Roman = Roman::from(7u32).unwrap();
let r: &u32 = &sept;
assert_eq!(&7, r);

fn as_ref(&self) -> &u32

Performs the conversion.

impl Clone for Roman

fn clone(&self) -> Roman

Returns a copy of the value.

pub 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 Deref for Roman

type Target = u32

The resulting type after dereferencing.

fn deref(&self) -> &u32

Returns the integer representation of the Roman numeral

impl Display for Roman

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

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, Error>

Creates a Roman numeral from a string representing the roman numerals

Examples

let sept: Roman = "VII".parse().unwrap();
assert_eq!(7, *sept);

Returns Roman , or an septem::Error

impl Ord for Roman

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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 Send for Roman

impl StructuralEq for Roman

impl StructuralPartialEq for Roman

impl Sync for Roman