sci-cream 0.0.2

Library that facilitates the mathematical analysis of ice cream mixes and their properties.
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

//! Error types for Sci-Cream.

use thiserror::Error;

#[cfg(feature = "wasm")]
use wasm_bindgen::JsValue;

use crate::specs::Unit;

/// Error type for Sci-Cream.
#[derive(Error, Debug)]
pub enum Error {
    /// Cannot compute energy due to unmet preconditions.
    #[error("Preconditions for computing energy not met: {0}")]
    CannotComputeEnergy(String),
    /// Cannot compute POD due to unmet preconditions.
    #[error("Preconditions for computing POD not met: {0}")]
    CannotComputePOD(String),
    /// Cannot compute PAC due to unmet preconditions.
    #[error("Preconditions for computing PAC not met: {0}")]
    CannotComputePAC(String),
    /// Composition value is not within [0, 100]%.
    #[error("Composition is not within [0, 100]%: {0}")]
    CompositionNotWithin100Percent(f64),
    /// Composition does not sum to 100%.
    #[error("Composition does not sum to 100%: {0}")]
    CompositionNot100Percent(f64),
    /// Composition value is not positive.
    #[error("Composition value is not positive: {0}")]
    CompositionNotPositive(f64),
    /// General invalid composition error.
    #[error("Invalid composition: {0}")]
    InvalidComposition(String),
    /// [PAC](crate::docs#pac-afp-fpdf-se) value is negative.
    #[error("PAC value cannot be negative: {0}")]
    NegativePacValue(f64),
    /// [FPD](crate::docs#pac-afp-fpdf-se) value is positive.
    #[error("FPD value cannot be positive: {0}")]
    PositiveFpdValue(f64),
    /// Composition unit is not supported for this operation.
    #[error("Composition unit is not supported for this operation: {0}")]
    UnsupportedCompositionUnit(Unit),
    /// Ingredient not found in database or embedded list.
    #[error("Ingredient not found: {0}")]
    IngredientNotFound(String),
}

#[cfg(feature = "wasm")]
impl From<Error> for JsValue {
    fn from(error: Error) -> Self {
        JsValue::from_str(&error.to_string())
    }
}

/// Convenience type alias for [`Result<T, sci_cream::error::Error>`].
pub type Result<T> = std::result::Result<T, Error>;