memstead_base/
lib.rs

1//! Backend-agnostic graph kernel for Memstead.
2//!
3//! Hosts the parts of the engine that do not assume a git-backed
4//! storage: token-budget chunking, workspace-root utilities, the
5//! entity types and markdown pipeline (parse / generate / write), the
6//! in-memory store, graph queries and community detection, the mem
7//! router, the operation request/response types (including the
8//! gix-free read paths in `ops::health` / `ops::search`), the search
9//! index, validators, and rendering.
10//!
11//! Consumers that need only graph operations against directory or
12//! archive storage depend on this crate alone — its dependency closure
13//! does not include `gix`. Code that needs git-backed mems depends on
14//! `memstead-git-branch`, which builds on `memstead-base`.
15
16pub mod anchor;
17pub mod backend;
18pub mod binding;
19pub mod binding_migrate;
20pub mod build_info;
21pub mod check;
22pub mod chunking;
23pub mod derivation;
24pub mod domain_authority_wire;
25pub mod engine;
26pub mod entity;
27pub mod filesystem;
28pub mod friction;
29pub mod graph;
30pub mod ingest;
31pub mod markdown;
32pub mod mem;
33pub mod mem_management;
34pub mod ops;
35pub mod overview;
36pub mod pipeline;
37pub mod pipeline_edit;
38pub mod pipeline_migrate;
39pub mod pipeline_store;
40pub mod provenance;
41pub mod render;
42pub mod runtime_validator;
43pub mod schema_source;
44#[cfg(not(target_arch = "wasm32"))]
45pub mod search_index;
46pub mod section_format;
47pub mod storage;
48pub mod store;
49pub mod validator;
50pub mod vcs;
51pub mod workspace;
52pub mod workspace_root;
53pub mod workspace_store;
54
55use std::sync::Arc;
56
57use memstead_schema::{TypeDefinition, type_by_name};
58
59pub use anchor::{
60    ANCHOR_SIDECAR_PATH, Anchor, AnchorGrain, AnchorHashStability, AnchorInput,
61    AnchorProvenanceClass, AnchorSidecar, AnchorState, AnchorValidationError, AnchorVersion,
62    ArtifactObservation, EntityAnchorComposition, INVALID_ANCHOR_CODE, compose_entity_anchors,
63    resolve_anchor,
64};
65pub use backend::{BackendError, MemBackend};
66pub use binding_migrate::{
67    BindingMigrateError, LegacyBindingV1, MigratedBinding, check_all_consumed, fold_v1_binding,
68    migrate_gen2_bindings,
69};
70pub use engine::{
71    BackendFactory, BootError, CreateEntityArgs, CreateEntityOutcome, DeleteEntityArgs,
72    DeleteEntityOutcome, DeleteReferrers, Engine, EngineError, EntityHistoryReport, EntityTouch,
73    FromArchiveBytesError, GitBranchBranchResetFn, GitBranchChangesSinceFn, GitBranchDiffFn,
74    GitBranchExportFn, GitBranchExportToBytesFn, GitBranchFetchFn, GitBranchOps, GitBranchPullFn,
75    GitBranchPushFn, GitBranchReadTreeFn, HISTORY_PAGE_DEFAULT, HISTORY_PAGE_MAX, INLINE_LIST_CAP,
76    MutationClock, ReferrerInfo, RelateAction, RelateEntityArgs, RelateEntityOutcome,
77    RenameEntityArgs, RenameEntityOutcome, ReviewMarkStatus, SchemaSourceDiagnostic, SchemaStaging,
78    SetReviewMarkOutcome, StoryStart, UpdateEntityArgs, UpdateEntityOutcome,
79    format_inline_list_overflow,
80};
81pub use entity::id::{ENTITY_ID_MAX_LEN, SlugError, TITLE_GRAMMAR_RULE};
82pub use entity::{Entity, EntityId, MetadataValue, ParseResult, Relationship};
83pub use graph::{ClusterInfo, LouvainOutput};
84pub use mem::{MEM_META_DIR, MemOrigin, MemRouterSnapshot};
85
86/// The engine crate SEMVER of the running binary. Version-carrying
87/// surfaces — the per-mem mutation stamp (`MemConfig.mutation_stamp`),
88/// the boot-time `ENGINE_VERSION_SKEW` comparison, the overview's
89/// `_engine_version`, CLI `--version`, MCP `serverInfo.version` — use
90/// [`build_info::full_version`] instead (semver plus the git build sha
91/// when present), so dev builds between releases stay distinguishable;
92/// this constant is the bare semver component.
93pub const ENGINE_VERSION: &str = env!("CARGO_PKG_VERSION");
94pub use mem_management::{CreateRuleSet, DeleteRuleSet, MatcherSet, MatcherSetError};
95pub use ops::{
96    BackendChanges, BatchEntry, BatchError, BatchResult, ChangeEnvelope, ChangesReport,
97    ContextResult, CreateArgs, CreateResult, DeleteResult, EMPTY_TREE_SHA, ExportResult, Facets,
98    HealthReport, HealthSummary, ListResult, MemExportResult, ModifiedMetadata, ModifiedSections,
99    Query, RENAME_SIMILARITY_DEFAULT, RENAME_SIMILARITY_MAX, RENAME_SIMILARITY_MIN, RelateArg,
100    RelateResult, ReloadReport, ReloadResult, RenameResult, SearchHit, SearchResult, SearchScope,
101    SetMemVersionOutcome, UpdateArgs, UpdateResult, WarningHint,
102};
103pub use pipeline::{
104    Facet, IngestTrigger, Medium, MediumType, PatternEntry, PatternMode, Projection,
105};
106pub use pipeline_edit::PipelineEditError;
107pub use pipeline_migrate::{migrate_legacy_pipeline, read_legacy_pipeline_configs};
108pub use pipeline_store::{
109    BindingConfigs, MemPipelineRecord, PipelineConfigs, PipelineRecord,
110    load_legacy_pipeline_configs, load_pipeline_configs,
111};
112pub use provenance::{Provenance, ProvenanceKind};
113pub use store::{Edge, EdgeSource, InEdge, Store};
114pub use workspace::{
115    CreateRuleSetting, DeleteRuleSetting, Mount, MountCapability, MountLifecycle, MountStorage,
116    SCHEMA_WILDCARD, Workspace, WorkspaceSettings,
117};
118pub use workspace_store::{
119    FileWorkspaceStore, InstantiateError, Layout, StoreError, WORKSPACE_STORE_DIR,
120    WorkspaceStoreAdapter, detect_layout, instantiate_lean_backend, is_mem_repo_shaped,
121    is_workspace_root, standalone_workspace, workspace_shape_label,
122};
123
124/// Lowercase hex encoding of a digest. Byte-identical to the `{:x}`
125/// formatting that `sha2 < 0.11` digests carried; hash strings persisted
126/// under the old encoding must keep matching.
127pub fn hex_lower(bytes: &[u8]) -> String {
128    use std::fmt::Write;
129    bytes
130        .iter()
131        .fold(String::with_capacity(bytes.len() * 2), |mut s, b| {
132            let _ = write!(s, "{b:02x}");
133            s
134        })
135}
136
137/// Engine-wide sentinel type. Used by ops that need a shared reference
138/// type at the Engine level (search, health, list) — always resolves to
139/// `default@1.0.0::spec`. Per-entity resolution still goes through
140/// `type_by_name` + schema lookup.
141pub fn engine_fallback_type() -> Arc<TypeDefinition> {
142    type_by_name("spec").expect("spec type must exist in the default builtin schema")
143}
memstead_base/lib.rs

memstead_base/
lib.rs
