icydb-core 0.67.0

IcyDB — A type-safe, embedded ORM and schema system for the Internet Computer
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

//! Module: model
//!
//! Responsibility: module-local ownership and contracts for model.
//! Does not own: cross-module orchestration outside this module.
//! Boundary: exposes this module API while keeping implementation details internal.

//! Runtime data model definitions.
//!
//! This module contains the *runtime representations* of schema-level concepts,
//! as opposed to their declarative or macro-time forms. Types in `model` are
//! instantiated and used directly by query planning, executors, and storage
//! layers.
//!
//! Currently this includes index-related models, but the module is intended to
//! grow to encompass additional runtime schema nodes (e.g. entities, fields,
//! or constraints) as IcyDB’s internal model is made more explicit.
//!
//! In general:
//! - Schema / macro code defines *what exists*
//! - `model` defines *what runs*
//!
//! Model types are **internal** runtime artifacts derived from typed entities.
//! Downstream code should not construct them manually except in tests that
//! intentionally exercise invalid or edge-case schemas.

pub(crate) mod entity;
pub(crate) mod field;
pub(crate) mod index;

// re-exports
pub use entity::EntityModel;
pub use field::{EnumVariantModel, FieldKind, FieldModel, FieldStorageDecode, RelationStrength};
pub use index::{IndexExpression, IndexKeyItem, IndexKeyItemsRef, IndexModel};