Skip to main content

lemma/
lib.rs

1//! # Lemma Engine
2//!
3//! **Rules for man and machine**
4//!
5//! Consumer API: **`load`** → **`list`** → **`show`** / **`source`** → **`run`**.
6
7#[cfg(test)]
8mod tests;
9
10pub(crate) mod computation;
11pub(crate) mod engine;
12pub(crate) mod error;
13pub(crate) mod evaluation;
14pub(crate) mod formatting;
15pub(crate) mod limits;
16pub(crate) mod literals;
17pub(crate) mod parsing;
18pub(crate) mod planning;
19pub mod quality;
20pub(crate) mod registry;
21pub mod result_value;
22pub(crate) mod spec_set_id;
23pub(crate) mod stdlib;
24
25#[cfg(not(target_arch = "wasm32"))]
26pub mod deps;
27
28#[cfg(target_arch = "wasm32")]
29pub mod wasm;
30
31pub use computation::{OperationResult, VetoType};
32pub use engine::{
33    resolve_effective, Engine, Errors, ListedSpec, ResolvedRepository, EMBEDDED_STDLIB_REPOSITORY,
34};
35pub use error::{EngineError, EngineErrorSource, Error, ErrorDetails, ErrorKind, RequestErrorKind};
36pub use evaluation::explanations::{format_explanation, Cause, Explanation, ExplanationNode};
37pub use evaluation::response::{Response, RuleResult};
38pub use evaluation::run_data::RunDataValue;
39pub use formatting::{format_parse_result, format_source, format_specs};
40pub use limits::{
41    ResourceLimits, MAX_DATA_NAME_LENGTH, MAX_RULE_NAME_LENGTH, MAX_SPEC_NAME_LENGTH,
42};
43pub use literals::{DateGranularity, MeasureUnit, MeasureUnits, RatioUnit, RatioUnits};
44pub use parsing::ast::DateTimeValue;
45pub use parsing::source::SourceType;
46pub use planning::execution_plan::type_detail_lines;
47pub use planning::execution_plan::{Show, ShowData, ShowVersion};
48pub use planning::explanation::{ConversionTraceRole, SerializedConversionTraceStep};
49pub use planning::semantics::{DataPath, LemmaType, LiteralValue, TypeSpecification, ValueKind};
50pub use result_value::{CalendarResult, RangeResult, RuleResultValue, RuleResultValueFailure};
51pub use spec_set_id::parse_spec_set_id;
52pub use stdlib::UNITS_LEMMA;
53
54/// Exact rational helpers for in-tree integration tests. Not a supported consumer API.
55#[doc(hidden)]
56pub mod __test_support {
57    pub use crate::computation::rational::{
58        checked_div, checked_mul, decimal_to_rational, rational_new,
59    };
60    pub use crate::literals::TimeValue;
61    pub use crate::planning::semantics::{SemanticDateTime, SemanticTime, SemanticTimezone};
62
63    /// Serializes an [`Error`](crate::Error) as [`EngineError`](crate::EngineError).
64    pub fn current_binding_error_json(error: &crate::Error) -> serde_json::Value {
65        serde_json::to_value(crate::EngineError::from(error))
66            .expect("BUG: EngineError must serialize")
67    }
68}
69
70// Tier 1 — language surface (always)
71pub use parsing::ast::{
72    try_parse_type_constraint_command, DataValue, Span, SpecRef, TimezoneValue,
73};
74pub use parsing::lexer::{Lexer, TokenKind};
75pub use parsing::source::Source;
76pub use parsing::{parse, ParseResult};
77pub use quality::{Recommendation, RecommendationKind};
78
79// Tier 2 — registry network (feature-gated)
80#[cfg(feature = "registry")]
81pub use engine::Context;
82#[cfg(feature = "registry")]
83pub use parsing::ast::{LemmaRepository, LemmaSpec};
84#[cfg(feature = "registry")]
85pub use planning::LemmaSpecSet;
86#[cfg(all(feature = "registry", not(target_arch = "wasm32")))]
87pub use registry::resolve_registry_references;
88pub use registry::RegistryErrorKind;
89#[cfg(feature = "registry")]
90pub use registry::{LemmaBase, Registry, RegistryBundle, RegistryError};