dimensional 0.1.0

Functions, structs, and reference data for working with dimensional values, such as '1 second' and '3 miles per hour'.
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

use std::{error::Error, fmt::Display};

#[derive(Debug, PartialEq, Eq)]
pub enum DimensionalOperationError {
    /// The units used in the operation have differing dimensions, and cannot
    /// produce a meaningful result.
    ///
    /// # Examples
    ///
    /// Attempting to add 3 seconds to 3 metres will produce this error.
    /// ```
    /// # use std::collections::HashMap;
    /// # use dimensional::{dim, Dimensional, DimensionalOperationError};
    /// use dimensional::si::Dimensions as SI;
    /// assert_eq!(
    ///     dim!(3.0, SI::Length => 1) + dim!(3.0, SI::Time => 1),
    ///     Err(DimensionalOperationError::DifferingDimensions)
    /// );
    /// ```
    DifferingDimensions,
}

impl Display for DimensionalOperationError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            DimensionalOperationError::DifferingDimensions => {
                write!(f, "attempted to perform an operation that does not support value with different dimensions")
            }
        }
    }
}

impl Error for DimensionalOperationError {}