use-rational 0.0.3

Utility-first rational-number primitives for RustUse
Documentation 
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

use core::fmt;
use std::error::Error;

/// Errors returned by validated rational-number helpers.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RationalError {
    /// A rational denominator must not be zero.
    ZeroDenominator,
    /// Division by a zero-valued rational is undefined.
    DivisionByZero,
    /// Sign normalization could not be represented in the current integer type.
    NormalizationOverflow,
    /// Exact arithmetic overflowed the current integer representation.
    ArithmeticOverflow {
        /// The checked operation that overflowed.
        operation: &'static str,
    },
}

impl fmt::Display for RationalError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::ZeroDenominator => write!(formatter, "denominator must not be zero"),
            Self::DivisionByZero => write!(formatter, "division by zero-valued rational"),
            Self::NormalizationOverflow => {
                write!(
                    formatter,
                    "rational normalization overflowed the current representation"
                )
            },
            Self::ArithmeticOverflow { operation } => {
                write!(
                    formatter,
                    "rational {operation} overflowed the current representation"
                )
            },
        }
    }
}

impl Error for RationalError {}