sim-relation-core 0.1.0

Open relational domain, row, and canonical identity records for SIM.
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

//! Open relational records built directly on the kernel data substrate.
//!
//! A logical domain is a [`DomainSpec`] in a [`DomainCatalog`], not an enum
//! variant. Storage providers consume its [`StorageRepr`], while runtime Shape
//! resolution is deliberately left to `sim-relation-shape`.
//!
//! ```
//! use sim_kernel::{Ref, Symbol};
//! use sim_relation_core::{DomainCatalog, DomainId, DomainSpec, DomainTrait, StorageRepr};
//!
//! let uuid = DomainSpec::new(
//!     DomainId::new(Symbol::qualified("example", "uuid")).unwrap(),
//!     StorageRepr::Text,
//!     Ref::Symbol(Symbol::qualified("example", "UuidShape")),
//!     [DomainTrait::Equatable, DomainTrait::Ordered],
//! ).unwrap();
//! let catalog = DomainCatalog::new([uuid]).unwrap();
//! assert!(catalog.get(&DomainId::new(Symbol::qualified("example", "uuid")).unwrap()).is_some());
//! ```

#![forbid(unsafe_code)]
#![deny(missing_docs)]

mod domain;
mod names;
mod record;

pub use domain::{
    BaseDomain, DomainCatalog, DomainError, DomainSpec, DomainTrait, StorageRepr, StorageValue,
};
pub use names::{
    BindingName, ColumnName, ConstraintName, DomainId, FieldName, IndexName, NameError,
    ParameterName, ProviderName, RevisionName, SchemaName, SourceName, TableName, ViewName,
};
pub use record::{Cell, FieldType, RelationId, Row, RowError, RowType, ToRelationDatum};