icydb_core/lib.rs
1//! Module: lib
2//! Responsibility: crate root for the IcyDB core runtime surface.
3//! Does not own: canister-facing facade APIs from the public `icydb` crate.
4//! Boundary: exposes the engine subsystems used by schema, query, executor, and storage layers.
5
6//! Core runtime for IcyDB: accepted-schema execution, values, storage, and
7//! the low-level vocabulary exported through the facade.
8#![warn(unreachable_pub)]
9// The no-default test target intentionally type-checks shared test/helper
10// surfaces whose consuming tests live behind SQL. Keep production and
11// all-features dead-code linting strict.
12#![cfg_attr(
13 all(test, not(feature = "sql")),
14 expect(dead_code, reason = "shared test helpers have SQL consumers")
15)]
16// The base build owns the complete engine-neutral planner/executor substrate.
17// SQL is an optional frontend over that substrate and is currently the only
18// consumer of some SQL explain, diagnostic, and frontend-extension capabilities,
19// so those internal extension points are intentionally dormant without SQL.
20#![cfg_attr(
21 all(not(test), not(feature = "sql")),
22 expect(
23 dead_code,
24 reason = "SQL-only explain, diagnostic, and frontend-extension capabilities remain intentionally dormant in base builds"
25 )
26)]
27
28extern crate self as icydb;
29
30#[macro_use]
31pub(crate) mod scalar_registry;
32
33mod codec;
34
35// public exports are one module level down
36pub mod db;
37pub mod error;
38pub mod metrics;
39mod retained;
40pub(crate) mod runtime;
41pub mod traits;
42pub mod types;
43pub mod value;
44
45#[cfg(test)]
46pub(crate) mod testing;
47
48///
49/// CONSTANTS
50///
51pub use icydb_schema::MAX_INDEX_FIELDS;
52
53///
54/// Prelude
55///
56/// Prelude contains only domain vocabulary.
57/// No errors, executors, stores, serializers, or helpers are re-exported here.
58///
59
60pub mod prelude {
61 pub use crate::{
62 traits::Path,
63 value::{InputValue, OutputValue},
64 };
65}