Struct Fraction

pub struct Fraction { /* private fields */ }

A fraction, convertible to Chinese.

Must be created by calling try_new; later, its components can be accessed via the numerator and denominator methods:

use chinese_format::*;

let fraction = Fraction::try_new(8, 3)?;

assert_eq!(fraction.numerator(), 3);
assert_eq!(fraction.denominator(), 8);

Implementations

impl Fraction

pub fn try_new( denominator: u128, numerator: i128, ) -> Result<Fraction, ZeroDenominator>

Tries to create a new fraction - failing with ZeroDenominator if the denominator is 0.

Please, note: as expected in Chinese, the denominator must be passed first.

The construction only fails when 0 is passed as the denominator:

use chinese_format::*;

let fraction = Fraction::try_new(9, 4)?;
assert_eq!(fraction.numerator(), 4);
assert_eq!(fraction.denominator(), 9);

let error_result = Fraction::try_new(0, 3);
assert_eq!(error_result, Err(ZeroDenominator));

pub fn denominator(&self) -> u128

pub fn numerator(&self) -> i128

Trait Implementations

impl ChineseFormat for Fraction

Fractions can be infallibly converted to Chinese.

They are omissible - and converted to 零 - only when the numerator is 0.

use chinese_format::*;

//Positive fractions
let positive_fraction = Fraction::try_new(8, 3)?;
assert_eq!(positive_fraction.to_chinese(Variant::Simplified), Chinese {
    logograms: "八分之三".to_string(),
    omissible: false
});
assert_eq!(positive_fraction.to_chinese(Variant::Traditional), "八分之三");

//Zero fractions, no matter the denominator
let zero_fraction = Fraction::try_new(8, 0)?;
assert_eq!(zero_fraction.to_chinese(Variant::Simplified), Chinese {
    logograms: "零".to_string(),
    omissible: true
});
assert_eq!(zero_fraction.to_chinese(Variant::Traditional), "零");

//Negative fractions
let negative_fraction = Fraction::try_new(3, -11)?;
assert_eq!(negative_fraction.to_chinese(Variant::Simplified), Chinese {
    logograms: "负三分之十一".to_string(),
    omissible: false
});
assert_eq!(negative_fraction.to_chinese(Variant::Traditional), "負三分之十一");

fn to_chinese(&self, variant: Variant) -> Chinese

impl Clone for Fraction

fn clone(&self) -> Fraction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Fraction

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

Formats the value using the given formatter.

impl Hash for Fraction

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Fraction

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Fraction

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Fraction

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Fraction

impl Eq for Fraction

impl StructuralPartialEq for Fraction