kip 0.1.1

Pure thread-safe engineering expression evaluator for US imperial units
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

//! Per-argument unit contracts for equation packs.

use std::sync::Arc;

use crate::dim::Dimension;
use crate::eval::value::Quantity;
use crate::parser::Expr;
use crate::quantity::UnitExpr;

/// Whether an out-of-range argument is a lint or hard error.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RangeSeverity {
    /// `L-RANGE` — evaluation may continue (not surfaced by `eval` v1).
    Lint,
    /// `E-RANGE` — evaluation fails.
    Error,
}

/// Declared validity range for an argument (in contract units).
#[derive(Debug, Clone)]
pub struct ArgRange {
    /// Inclusive minimum, if any.
    pub min: Option<Quantity>,
    /// Inclusive maximum, if any.
    pub max: Option<Quantity>,
    /// How to treat violations.
    pub severity: RangeSeverity,
}

/// Contract for one named pack-equation argument.
#[derive(Debug, Clone)]
pub struct ArgContract {
    /// Parameter name (`fc`, `lambda`, …).
    pub name: String,
    /// Required unit expression (`psi`, `1`, …).
    pub unit: UnitExpr,
    /// Cached dimension of `unit`.
    pub dim: Dimension,
    /// Optional validity range.
    pub range: Option<ArgRange>,
    /// Pre-parsed default expression (dimensionless modifiers only).
    pub default_expr: Option<Arc<Expr>>,
}