Struct MeasureUnit 

pub struct MeasureUnit {
    pub name: String,
    pub scale: UnitScale,
    pub derived_measure_factors: Vec<(String, i32)>,
    pub decomposition: BTreeMap<Dimension, i32>,
    pub minimum: Option<RationalInteger>,
    pub maximum: Option<RationalInteger>,
    pub suggestion_magnitude: Option<RationalInteger>,
}

A single unit within a Measure type.

scale is the conversion factor: 1 of this unit equals scale canonical units when the scale is a literal, or a referenced number when it is dynamic. derived_measure_factors stores (measure_ref, exponent) pairs from compound unit declarations (e.g., meter/second produces [("meter", 1), ("second", -1)]). Empty for base units. decomposition is the dimensional decomposition vector, populated during the planning decomposition pass. It is empty until that pass completes.

Fields

name: String

scale: UnitScale

derived_measure_factors: Vec<(String, i32)>

decomposition: BTreeMap<Dimension, i32>

minimum: Option<RationalInteger>

Minimum magnitude in this unit (schema/UI); canonical bound is on the type.

maximum: Option<RationalInteger>

Maximum magnitude in this unit (schema/UI).

suggestion_magnitude: Option<RationalInteger>

Default suggestion magnitude in this unit (schema/UI).

Implementations

impl MeasureUnit

pub fn from_decimal_factor( name: String, decimal_factor: Decimal, derived_measure_factors: Vec<(String, i32)>, ) -> Result<Self, String>

pub fn from_reference( name: String, written: String, segments: Vec<String>, reference_name: String, ) -> Self

pub fn clear_constraint_magnitudes(&mut self)

pub fn is_dynamic(&self) -> bool

pub fn scale_written(&self) -> Option<String>

Source spelling of a reference scale (rate, fx.rate).

pub fn resolved_scale_target(&self) -> Option<&ReferenceTarget>

Declaring-spec target after graph resolution.

pub fn scale_reference_parts(&self) -> Option<(&[String], &str)>

Written reference path (segments + name) of an unresolved dynamic unit.

pub fn literal_factor(&self) -> Option<&RationalInteger>

Literal conversion factor, when this unit’s scale is known at plan time.

pub fn require_literal_factor(&self) -> &RationalInteger

Literal conversion factor. Panics if this unit is reference-scaled: planning keeps every static path away from dynamic units.

pub fn same_consumer_scale( &self, other: &Self, self_import_path: &[String], other_import_path: &[String], ) -> bool

Whether this unit and other have the same scale in consumer coordinates: equal literal factors, or equal reference paths after prefixing each owner’s import path.

pub fn is_canonical_factor(&self) -> bool

pub fn is_positive_factor(&self) -> bool

pub fn factor_decimal(&self) -> Decimal

Conversion factor as decimal (schema unit factors always commit).

pub fn minimum_decimal(&self) -> Option<Decimal>

pub fn maximum_decimal(&self) -> Option<Decimal>

pub fn suggestion_magnitude_decimal(&self) -> Option<Decimal>

pub fn maximum_canonical_decimal(&self) -> Option<Decimal>

Maximum bound lifted to canonical units via maximum * factor.

impl MeasureUnit

pub fn with_decomposition(self, decomposition: BTreeMap<Dimension, i32>) -> Self

pub fn with_factor(self, factor: RationalInteger) -> Self

pub fn with_resolved_scale(self, resolved: ReferenceTarget) -> Self

pub fn with_derived_measure_factors( self, derived_measure_factors: Vec<(String, i32)>, ) -> Self

Trait Implementations

impl Clone for MeasureUnit

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MeasureUnit

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

Formats the value using the given formatter.

impl Eq for MeasureUnit

impl From<&MeasureUnit> for MeasureUnit

fn from(unit: &DomainMeasureUnit) -> Self

Converts to this type from the input type.

impl Hash for MeasureUnit

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 PartialEq for MeasureUnit

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MeasureUnit